Skip to main content

API

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

Overview​

The Ordify API lets you:

  • Build custom applications: Create your own apps 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 API integrations

API Management Interface

Getting started​

Access API Management​

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

Generate a new API key​

  1. Go to Settings → API
  2. Click Generate New API Key
  3. Copy the key immediately — it won't be shown again
  4. Store your API key securely

Manage API keys​

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

Interactive API documentation​

Test your agent API directly in your browser:

View Interactive API Documentation →

Interactive API Documentation

The interactive documentation provides:

  • Live API testing: Test 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

Authentication​

All API requests require authentication using your API key:

Authorization: Bearer YOUR_API_KEY

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, not in source code
  • Rotate keys regularly: Generate new keys and delete old ones periodically
  • Monitor usage: Regularly review your API key usage and access logs

Next steps​