API Invocation
A common use case for Orchestra workflows is to be integrated into or invoked from an external application. This can be done using the Workflow API. The Workflow API provides endpoints to list available workflows, execute workflows, track execution status, and more.
Available APIs
Swagger Documentation
Arcee Orchestra Swagger Documentation
Setting up an API Key
All API requests require authentication using a Bearer token. To generate an API key:
Go to Settings --> API Tokens --> Add API Token.
Provide a name and select "Get API Token".
Copy the generated API Key. You will not be able to view this again so ensure you store it somewhere secure. You will also be provided code examples for calling the APIs in Javascript and Python.
Core Functionality
Each API call will use the API Key generated with the steps above as well as the base url: https://orchestra.arcee.ai/api/v1/workflow.
Error Handling
All APIs adhere to standard HTTP status codes:
200 OK – Request successful
400 Bad Request – Invalid input
401 Unauthorized – Invalid or missing authentication
404 Not Found – Resource not found
500 Internal Server Error – Server-side error
Proper error handling should be implemented when interacting with the API to manage failures effectively.
Security Best Practices
To ensure secure API interactions, follow these best practices:
Store API tokens securely in environment variables or credential stores.
Use HTTPS for all API requests to prevent data interception.
Implement proper error handling to avoid exposing sensitive information in API responses.
Last updated