Skip to main content

API Management

Create custom applications with your Ordify agents by utilizing the Ordify API. Build integrations, automate workflows, and connect your agents to external systems using our comprehensive API.

Overview​

The Ordify API allows you to programmatically interact with your agents, enabling you to:

  • Build Custom Applications: Create your own applications that leverage Ordify's AI agents
  • Integrate with External Systems: Connect Ordify agents to your existing tools and platforms
  • Automate Workflows: Build automated processes that use your agents
  • Test and Debug: Use interactive documentation to test and debug your API integrations

API Management Interface

Getting Started​

Accessing API Management​

To manage your API keys and access the API:

  1. Navigate to Account → API
  2. View your existing API keys or generate new ones
  3. Access interactive documentation to test your API calls

Generate New API Key​

To create a new API key:

  1. Go to Account → API
  2. Click Generate New API Key
  3. Your new API key will be created and displayed
  4. Copy the key immediately—it won't be shown again
  5. Store your API key securely

API Management Interface

Managing API Keys​

In the API Management interface, you can:

  • View All Keys: See all your active API keys with creation dates and expiration information
  • Copy Keys: Click the copy icon to quickly copy an API key to your clipboard
  • Delete Keys: Remove API keys that are no longer needed using the delete icon
  • Monitor Usage: Track when keys were created and when they expire

Interactive API Documentation​

Test your agent API with our interactive documentation:

View Interactive API Documentation →

Interactive API Documentation

The interactive documentation provides:

  • Live API Testing: Test API endpoints directly in your browser
  • Request Examples: See example requests for all available endpoints
  • Response Schemas: Understand the structure of API responses
  • Authentication Guide: Learn how to authenticate your API requests
  • Code Samples: Get code examples in multiple programming languages

Using the API​

Authentication​

All API requests require authentication using your API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Creating Apps with Agents​

You can create applications that interact with your Ordify agents through the API:

  1. Get Your API Key: Generate an API key from Account → API
  2. Review Documentation: Use the interactive documentation to explore available endpoints
  3. Test Endpoints: Test API calls using the interactive docs
  4. Build Your Application: Integrate the API into your application using the provided examples

Common Use Cases​

  • Chat Integration: Build custom chat interfaces that use your Ordify agents
  • Workflow Automation: Automate business processes using agent capabilities
  • Data Processing: Process data through your agents programmatically
  • Custom Integrations: Connect Ordify to systems not available through Connect Apps or MCP

Security Best Practices​

  • Keep Keys Secure: Never commit API keys to version control
  • Use Environment Variables: Store API keys in environment variables
  • Rotate Keys Regularly: Generate new keys and delete old ones periodically
  • Monitor Usage: Regularly review your API key usage and access logs
  • Limit Permissions: Only grant necessary permissions to your API keys

Next Steps​