web-api.mdx 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. ---
  2. title: "API"
  3. description: "Reference documentation for the Agencii Platform API."
  4. icon: "code"
  5. ---
  6. ## Feature Overview
  7. API Integrations provide a set of endpoints allowing you to run your agents on custom backends or on other unsupported channels.
  8. <Info>
  9. ⚡ Live Postman Example: [Go to Postman →](https://www.postman.com/vrsen-ai/agencii-api/overview)
  10. </Info>
  11. ---
  12. ## Authentication
  13. - **Note**: You can only use platform tokens for these endpoints. Find or create one inside **Profile Icon > API Keys**.
  14. - **Headers**:
  15. - `Authorization`: `Bearer <your_token>`
  16. - **Example**: `Bearer sk-agencii-H7sb111...`
  17. - `Content-Type`: `application/json`
  18. ---
  19. ## Endpoints
  20. <CardGroup cols={2}>
  21. <Card
  22. title="Create New Chat"
  23. icon="plus"
  24. href="/platform/integrations/api/create-new-chat"
  25. >
  26. Start a new conversation session.
  27. </Card>
  28. <Card
  29. title="Get Response"
  30. icon="bolt"
  31. href="/platform/integrations/api/get-response"
  32. >
  33. Get a response from your agent.
  34. </Card>
  35. </CardGroup>
  36. ---
  37. ## Additional Notes
  38. - All timestamps are in ISO 8601 format.
  39. - Ensure that your `apiIntegrationId` is valid and corresponds to an existing integration.
  40. - Replace placeholder values with actual data when making requests.
  41. - The `attachments` parameter in `/get_response` allows you to include files and specify tools for processing.
  42. ---