Services Reference
Complete list of all SDK service classes and their methods, grouped by module. Each method corresponds to one REST endpoint.
actors
See actors module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
actors.listActors() | GET | /api/v1/api/v1/actors | List actors |
actors.createActor() | POST | /api/v1/api/v1/actors | Create an actor |
actors.getActor() | GET | /api/v1/api/v1/actors/{actor_id} | Get an actor by ID |
actors.deleteActor() | DELETE | /api/v1/api/v1/actors/{actor_id} | Delete an actor |
actors.updateActor() | PATCH | /api/v1/api/v1/actors/{actor_id} | Update an actor |
actors.getActorTags() | GET | /api/v1/api/v1/actors/{actor_id}/tags | Get actor tags |
actors.replaceActorTags() | PUT | /api/v1/api/v1/actors/{actor_id}/tags | Replace actor tags |
actors.mergeActorTags() | PATCH | /api/v1/api/v1/actors/{actor_id}/tags | Merge actor tags |
agents
See agents module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
agents.createAgent() | POST | /api/v1/api/v1/agents | Create an agent |
agents.listAgents() | GET | /api/v1/api/v1/agents | List agents |
agents.getAgent() | GET | /api/v1/api/v1/agents/{agent_id} | Get an agent |
agents.updateAgent() | PUT | /api/v1/api/v1/agents/{agent_id} | Update an agent |
agents.patchAgent() | PATCH | /api/v1/api/v1/agents/{agent_id} | Partially update an agent |
agents.deleteAgent() | DELETE | /api/v1/api/v1/agents/{agent_id} | Delete an agent |
agents.createAgentGeneration() | POST | /api/v1/api/v1/agents/{agent_id}/generate | Run an agent generation |
agents.submitAgentToolOutputs() | POST | /api/v1/api/v1/agents/{agent_id}/generate/{generation_id}/tool-outputs | Submit tool outputs for a paused generation |
aiProviders
See aiProviders module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
aiProviders.listAiProviders() | GET | /api/v1/api/v1/ai-providers | List AI providers |
aiProviders.createAiProvider() | POST | /api/v1/api/v1/ai-providers | Create an AI provider |
aiProviders.getAiProvider() | GET | /api/v1/api/v1/ai-providers/{ai_provider_id} | Get an AI provider |
aiProviders.updateAiProvider() | PATCH | /api/v1/api/v1/ai-providers/{ai_provider_id} | Update an AI provider |
aiProviders.deleteAiProvider() | DELETE | /api/v1/api/v1/ai-providers/{ai_provider_id} | Delete an AI provider |
aiProviders.getAiProviderPrices() | GET | /api/v1/api/v1/ai-providers/{ai_provider_id}/prices | List per-provider price overrides |
aiProviders.updateAiProviderPrices() | PUT | /api/v1/api/v1/ai-providers/{ai_provider_id}/prices | Upsert per-provider price overrides |
apiKeys
See apiKeys module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
apiKeys.listApiKeys() | GET | /api/v1/api/v1/api-keys | List API keys |
apiKeys.createApiKey() | POST | /api/v1/api/v1/api-keys | Create an API key |
apiKeys.getApiKey() | GET | /api/v1/api/v1/api-keys/{api_key_id} | Get an API key |
apiKeys.updateApiKey() | PUT | /api/v1/api/v1/api-keys/{api_key_id} | Update an API key |
apiKeys.deleteApiKey() | DELETE | /api/v1/api/v1/api-keys/{api_key_id} | Delete an API key |
chats
See chats module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
chats.createChat() | POST | /api/v1/api/v1/chats | Create a chat |
chats.listChats() | GET | /api/v1/api/v1/chats | List chats |
chats.getChat() | GET | /api/v1/api/v1/chats/{chat_id} | Get a chat |
chats.deleteChat() | DELETE | /api/v1/api/v1/chats/{chat_id} | Delete a chat |
chats.createChatCompletionForChat() | POST | /api/v1/api/v1/chats/{chat_id}/completions | Create a chat completion for a stored chat |
chats.createChatCompletion() | POST | /api/v1/api/v1/chat/completions | Create a chat completion (stateless) |
conversations
See conversations module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
conversations.listConversations() | GET | /api/v1/api/v1/conversations | List conversations |
conversations.createConversation() | POST | /api/v1/api/v1/conversations | Create a conversation |
conversations.getConversation() | GET | /api/v1/api/v1/conversations/{conversation_id} | Get a conversation by ID |
conversations.updateConversation() | PATCH | /api/v1/api/v1/conversations/{conversation_id} | Update a conversation |
conversations.deleteConversation() | DELETE | /api/v1/api/v1/conversations/{conversation_id} | Delete a conversation |
conversations.listConversationMessages() | GET | /api/v1/api/v1/conversations/{conversation_id}/messages | List conversation messages |
conversations.addConversationMessage() | POST | /api/v1/api/v1/conversations/{conversation_id}/messages | Add a message to a conversation |
conversations.generateConversationMessage() | POST | /api/v1/api/v1/conversations/{conversation_id}/generate | Generate the next message in a conversation |
conversations.removeConversationMessage() | DELETE | /api/v1/api/v1/conversations/{conversation_id}/messages/{document_id} | Remove a message from a conversation |
conversations.getConversationTags() | GET | /api/v1/api/v1/conversations/{conversation_id}/tags | Get conversation tags |
conversations.replaceConversationTags() | PUT | /api/v1/api/v1/conversations/{conversation_id}/tags | Replace conversation tags |
conversations.mergeConversationTags() | PATCH | /api/v1/api/v1/conversations/{conversation_id}/tags | Merge conversation tags |
discussions
See discussions module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
discussions.listDiscussions() | GET | /api/v1/api/v1/discussions | List discussions |
discussions.createDiscussion() | POST | /api/v1/api/v1/discussions | Create a discussion |
discussions.getDiscussionRun() | GET | /api/v1/api/v1/discussions/runs/{run_id} | Get a discussion run by ID |
discussions.getDiscussion() | GET | /api/v1/api/v1/discussions/{discussion_id} | Get a discussion by ID |
discussions.updateDiscussion() | PATCH | /api/v1/api/v1/discussions/{discussion_id} | Update a discussion |
discussions.deleteDiscussion() | DELETE | /api/v1/api/v1/discussions/{discussion_id} | Delete a discussion |
discussions.createDiscussionRun() | POST | /api/v1/api/v1/discussions/{discussion_id}/runs | Invoke a discussion |
discussions.listDiscussionRuns() | GET | /api/v1/api/v1/discussions/{discussion_id}/runs | List a discussion's runs |
documents
See documents module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
documents.listDocuments() | GET | /api/v1/api/v1/documents | List documents |
documents.createDocument() | POST | /api/v1/api/v1/documents | Create a document |
documents.ingestDocument() | POST | /api/v1/api/v1/documents/ingest | Ingest a file into a chunked document |
documents.getDocument() | GET | /api/v1/api/v1/documents/{document_id} | Get a document by ID |
documents.deleteDocument() | DELETE | /api/v1/api/v1/documents/{document_id} | Delete a document |
documents.updateDocument() | PATCH | /api/v1/api/v1/documents/{document_id} | Update a document |
documents.getDocumentStatus() | GET | /api/v1/api/v1/documents/{document_id}/status | Get document ingestion status |
documents.reingestDocument() | POST | /api/v1/api/v1/documents/{document_id}/ingest | Re-ingest an existing document |
documents.completeIngestionCallback() | POST | /api/v1/api/v1/documents/{document_id}/ingestion-callback | Deliver an async converter result |
documents.getDocumentTags() | GET | /api/v1/api/v1/documents/{document_id}/tags | Get document tags |
documents.replaceDocumentTags() | PUT | /api/v1/api/v1/documents/{document_id}/tags | Replace document tags |
documents.mergeDocumentTags() | PATCH | /api/v1/api/v1/documents/{document_id}/tags | Merge document tags |
embeddings
See embeddings module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
embeddings.createEmbeddings() | POST | /api/v1/api/v1/embeddings | Create embeddings |
files
See files module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
files.listFiles() | GET | /api/v1/api/v1/files | List all files |
files.createFile() | POST | /api/v1/api/v1/files | Create a file |
files.uploadFile() | POST | /api/v1/api/v1/files/upload | Upload a file |
files.uploadFileBase64() | POST | /api/v1/api/v1/files/upload/base64 | Upload a file using base64 encoding |
files.createPresignedUrl() | POST | /api/v1/api/v1/files/presigned-url | Create a presigned upload URL |
files.uploadFileWithToken() | POST | /api/v1/api/v1/files/upload/{token} | Upload a file using an upload token |
files.getFile() | GET | /api/v1/api/v1/files/{file_id} | Get a file by ID |
files.deleteFile() | DELETE | /api/v1/api/v1/files/{file_id} | Delete a file |
files.downloadFile() | GET | /api/v1/api/v1/files/{file_id}/download | Download a file |
files.updateFileMetadata() | PATCH | /api/v1/api/v1/files/{file_id}/metadata | Update file metadata |
files.downloadFileBase64() | GET | /api/v1/api/v1/files/{file_id}/download/base64 | Download file as base64 |
files.getFileTags() | GET | /api/v1/api/v1/files/{file_id}/tags | Get file tags |
files.replaceFileTags() | PUT | /api/v1/api/v1/files/{file_id}/tags | Replace file tags |
files.mergeFileTags() | PATCH | /api/v1/api/v1/files/{file_id}/tags | Merge file tags |
formations
See formations module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
formations.validateFormation() | POST | /api/v1/api/v1/formations/validate | Validate a formation template |
formations.planFormation() | POST | /api/v1/api/v1/formations/plan | Plan a formation deployment |
formations.listFormations() | GET | /api/v1/api/v1/formations | List formations |
formations.createFormation() | POST | /api/v1/api/v1/formations | Create a new formation |
formations.getFormation() | GET | /api/v1/api/v1/formations/{formation_id} | Get a specific formation |
formations.updateFormation() | PUT | /api/v1/api/v1/formations/{formation_id} | Update an formation |
formations.deleteFormation() | DELETE | /api/v1/api/v1/formations/{formation_id} | Delete an formation |
formations.listFormationEvents() | GET | /api/v1/api/v1/formations/{formation_id}/events | List formation operation events |
generations
See generations module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
generations.listGenerations() | GET | /api/v1/api/v1/generations | List generations |
generations.getGeneration() | GET | /api/v1/api/v1/generations/{generation_id} | Get a generation |
ingestionRules
See ingestionRules module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
ingestionRules.listIngestionRules() | GET | /api/v1/api/v1/ingestion-rules | List ingestion rules |
ingestionRules.createIngestionRule() | POST | /api/v1/api/v1/ingestion-rules | Create an ingestion rule |
ingestionRules.getIngestionRule() | GET | /api/v1/api/v1/ingestion-rules/{ingestion_rule_id} | Get an ingestion rule |
ingestionRules.updateIngestionRule() | PATCH | /api/v1/api/v1/ingestion-rules/{ingestion_rule_id} | Update an ingestion rule |
ingestionRules.deleteIngestionRule() | DELETE | /api/v1/api/v1/ingestion-rules/{ingestion_rule_id} | Delete an ingestion rule |
knowledge
See knowledge module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
knowledge.searchKnowledge() | POST | /api/v1/api/v1/knowledge/search | Search knowledge |
memories
See memories module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
memories.listMemories() | GET | /api/v1/api/v1/memories | List memories |
memories.createMemory() | POST | /api/v1/api/v1/memories | Create a memory |
memories.getMemory() | GET | /api/v1/api/v1/memories/{memory_id} | Get a memory |
memories.updateMemory() | PUT | /api/v1/api/v1/memories/{memory_id} | Update a memory |
memories.deleteMemory() | DELETE | /api/v1/api/v1/memories/{memory_id} | Delete a memory |
memoryEntries
See memoryEntries module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
memoryEntries.listMemoryEntries() | GET | /api/v1/api/v1/memory-entries | List memory entries |
memoryEntries.createMemoryEntry() | POST | /api/v1/api/v1/memory-entries | Create a memory entry |
memoryEntries.getMemoryEntry() | GET | /api/v1/api/v1/memory-entries/{entry_id} | Get a memory entry |
memoryEntries.updateMemoryEntry() | PUT | /api/v1/api/v1/memory-entries/{entry_id} | Update a memory entry |
memoryEntries.deleteMemoryEntry() | DELETE | /api/v1/api/v1/memory-entries/{entry_id} | Delete a memory entry |
orchestrations
See orchestrations module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
orchestrations.createOrchestration() | POST | /api/v1/api/v1/orchestrations | Create an orchestration |
orchestrations.listOrchestrations() | GET | /api/v1/api/v1/orchestrations | List orchestrations |
orchestrations.validateOrchestration() | POST | /api/v1/api/v1/orchestrations/validate | Validate an orchestration graph |
orchestrations.getOrchestration() | GET | /api/v1/api/v1/orchestrations/{orchestration_id} | Get an orchestration |
orchestrations.updateOrchestration() | PATCH | /api/v1/api/v1/orchestrations/{orchestration_id} | Update an orchestration |
orchestrations.deleteOrchestration() | DELETE | /api/v1/api/v1/orchestrations/{orchestration_id} | Delete an orchestration |
orchestrations.startOrchestrationRun() | POST | /api/v1/api/v1/orchestration-runs | Start an orchestration run |
orchestrations.listOrchestrationRuns() | GET | /api/v1/api/v1/orchestration-runs | List orchestration runs |
orchestrations.cancelOrchestrationRun() | POST | /api/v1/api/v1/orchestration-runs/{run_id}/cancel | Cancel an orchestration run |
orchestrations.submitHumanInput() | POST | /api/v1/api/v1/orchestration-runs/{run_id}/human-input | Submit human input |
orchestrations.resumeOrchestrationRun() | POST | /api/v1/api/v1/orchestration-runs/{run_id}/resume | Resume an orchestration run |
orchestrations.getOrchestrationRun() | GET | /api/v1/api/v1/orchestration-runs/{run_id} | Get an orchestration run |
policies
See policies module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
policies.listPolicies() | GET | /api/v1/api/v1/policies | List all policies |
policies.createPolicy() | POST | /api/v1/api/v1/policies | Create a policy |
policies.getPolicy() | GET | /api/v1/api/v1/policies/{policy_id} | Get a policy |
policies.updatePolicy() | PUT | /api/v1/api/v1/policies/{policy_id} | Update a policy |
policies.deletePolicy() | DELETE | /api/v1/api/v1/policies/{policy_id} | Delete a policy |
projects
See projects module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
projects.listProjects() | GET | /api/v1/api/v1/projects | List projects |
projects.createProject() | POST | /api/v1/api/v1/projects | Create a project |
projects.getProject() | GET | /api/v1/api/v1/projects/{project_id} | Get a project |
projects.updateProject() | PATCH | /api/v1/api/v1/projects/{project_id} | Rename a project |
projects.deleteProject() | DELETE | /api/v1/api/v1/projects/{project_id} | Delete a project |
projects.getProjectPrices() | GET | /api/v1/api/v1/projects/{project_id}/prices | List a project's price rows |
projects.updateProjectPrices() | PUT | /api/v1/api/v1/projects/{project_id}/prices | Upsert a project's price rows |
secrets
See secrets module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
secrets.listSecrets() | GET | /api/v1/api/v1/secrets | List secrets |
secrets.createSecret() | POST | /api/v1/api/v1/secrets | Create a secret |
secrets.getSecret() | GET | /api/v1/api/v1/secrets/{secret_id} | Get a secret |
secrets.updateSecret() | PATCH | /api/v1/api/v1/secrets/{secret_id} | Update a secret |
secrets.deleteSecret() | DELETE | /api/v1/api/v1/secrets/{secret_id} | Delete a secret |
sessions
See sessions module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
sessions.createSession() | POST | /api/v1/api/v1/sessions | Create a session |
sessions.listSessions() | GET | /api/v1/api/v1/sessions | List sessions |
sessions.getSession() | GET | /api/v1/api/v1/sessions/{session_id} | Get a session |
sessions.updateSession() | PATCH | /api/v1/api/v1/sessions/{session_id} | Update a session |
sessions.deleteSession() | DELETE | /api/v1/api/v1/sessions/{session_id} | Delete a session |
sessions.addSessionMessage() | POST | /api/v1/api/v1/sessions/{session_id}/messages | Add a user message |
sessions.generateSessionResponse() | POST | /api/v1/api/v1/sessions/{session_id}/generate | Trigger agent generation |
sessions.submitSessionToolOutputs() | POST | /api/v1/api/v1/sessions/{session_id}/tool-outputs | Submit tool outputs |
sessions.getSessionTags() | GET | /api/v1/api/v1/sessions/{session_id}/tags | Get session tags |
sessions.replaceSessionTags() | PUT | /api/v1/api/v1/sessions/{session_id}/tags | Replace session tags |
sessions.mergeSessionTags() | PATCH | /api/v1/api/v1/sessions/{session_id}/tags | Merge session tags |
tools
See tools module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
tools.createTool() | POST | /api/v1/api/v1/tools | Create a tool |
tools.listTools() | GET | /api/v1/api/v1/tools | List tools |
tools.getTool() | GET | /api/v1/api/v1/tools/{tool_id} | Get a tool |
tools.updateTool() | PATCH | /api/v1/api/v1/tools/{tool_id} | Update a tool |
tools.deleteTool() | DELETE | /api/v1/api/v1/tools/{tool_id} | Delete a tool |
tools.callTool() | POST | /api/v1/api/v1/tools/{tool_id}/call | Call a tool |
traces
See traces module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
traces.listTraces() | GET | /api/v1/api/v1/traces | List traces |
traces.getTrace() | GET | /api/v1/api/v1/traces/{trace_id} | Get a trace |
traces.getTraceTree() | GET | /api/v1/api/v1/traces/{trace_id}/tree | Get trace tree |
triggers
See triggers module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
triggers.listTriggers() | GET | /api/v1/api/v1/triggers | List triggers |
triggers.createTrigger() | POST | /api/v1/api/v1/triggers | Create a trigger |
triggers.getTrigger() | GET | /api/v1/api/v1/triggers/{trigger_id} | Get a trigger |
triggers.updateTrigger() | PATCH | /api/v1/api/v1/triggers/{trigger_id} | Update a trigger |
triggers.deleteTrigger() | DELETE | /api/v1/api/v1/triggers/{trigger_id} | Delete a trigger |
triggers.fireTrigger() | POST | /api/v1/api/v1/triggers/{trigger_id}/fire | Fire a trigger |
triggers.getTriggerSecret() | GET | /api/v1/api/v1/triggers/{trigger_id}/secret | Get trigger secret |
triggers.rotateTriggerSecret() | POST | /api/v1/api/v1/triggers/{trigger_id}/rotate-secret | Rotate trigger secret |
triggers.listTriggerFirings() | GET | /api/v1/api/v1/trigger-firings | List trigger firings |
triggers.getTriggerFiring() | GET | /api/v1/api/v1/trigger-firings/{firing_id} | Get a trigger firing |
usage
See usage module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
usage.listUsageMeters() | GET | /api/v1/api/v1/usage/meters | List usage meters |
usage.getUsageReceipt() | GET | /api/v1/api/v1/usage/receipt | Get a generation's billing receipt |
usage.getPriceBook() | GET | /api/v1/api/v1/usage/prices | Get the price book |
usage.upsertPriceBook() | PUT | /api/v1/api/v1/usage/prices | Upsert price-book rows |
users
See users module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
users.getCurrentUser() | GET | /api/v1/api/v1/users/me | Get the current authenticated user |
users.listUsers() | GET | /api/v1/api/v1/users | List all users |
users.createUser() | POST | /api/v1/api/v1/users | Create a user |
users.getUser() | GET | /api/v1/api/v1/users/{user_id} | Get a user by ID |
users.deleteUser() | DELETE | /api/v1/api/v1/users/{user_id} | Delete a user by ID |
users.bootstrapUser() | POST | /api/v1/api/v1/users/bootstrap | Create the first admin user |
users.loginUser() | POST | /api/v1/api/v1/users/login | Login user |
users.attachUserPolicies() | PUT | /api/v1/api/v1/users/{user_id}/policies | Attach policies to a user |
webhooks
See webhooks module docs for permissions and data model.
| Method | HTTP | Path | Description |
|---|---|---|---|
webhooks.listWebhooks() | GET | /api/v1/api/v1/webhooks | List webhooks |
webhooks.createWebhook() | POST | /api/v1/api/v1/webhooks | Create a webhook |
webhooks.getWebhook() | GET | /api/v1/api/v1/webhooks/{webhook_id} | Get a webhook |
webhooks.updateWebhook() | PUT | /api/v1/api/v1/webhooks/{webhook_id} | Update a webhook |
webhooks.deleteWebhook() | DELETE | /api/v1/api/v1/webhooks/{webhook_id} | Delete a webhook |
webhooks.listWebhookDeliveries() | GET | /api/v1/api/v1/webhook-deliveries | List webhook deliveries |
webhooks.getWebhookDelivery() | GET | /api/v1/api/v1/webhook-deliveries/{delivery_id} | Get a delivery |
webhooks.getWebhookSecret() | GET | /api/v1/api/v1/webhooks/{webhook_id}/secret | Get webhook secret |
webhooks.rotateWebhookSecret() | POST | /api/v1/api/v1/webhooks/{webhook_id}/rotate-secret | Rotate webhook secret |