Skip to main content

​
Feature Overview

API Integrations provide a set of endpoints allowing you to run your agents on custom backends or on other unsupported channels.
⚡ Live Postman Example: Go to Postman →

​
Authentication

  • Note: You can only use platform tokens for these endpoints. Find or create one inside Profile Icon > API Keys.
  • Headers:
    • Authorization: Bearer <your_token>
      • Example: Bearer sk-agencii-H7sb111...
    • Content-Type: application/json

​
Endpoints

Create New Chat

Start a new conversation session.

Get Response

Get a response from your agent.

Stream API v2 Completion

Stream an agent run with member attribution and file attachments.

Create Agency Upload

Upload a member’s file where your agent can read it with sandbox tools.

​
Recover an interrupted API v2 request

Use a unique usageRequestId for each request. If an error includes X-Agent-Run-Admitted: false, the request was rejected before a run started. If a connection ends without that header, the agent may still be working. Read /get_chat_messages and match status.usageRequestId before retrying. An older completed response does not mean the current run has finished.

​
Additional Notes

  • All timestamps are in ISO 8601 format.
  • Ensure that your apiIntegrationId is valid and corresponds to an existing integration.
  • Replace placeholder values with actual data when making requests.
  • The attachments parameter in /get_response allows you to include files and specify tools for processing.
  • API v1 behavior is unchanged and does not enforce per-consumer allowances.