The API interface provides programmatic access to your agent through REST API calls. This interface is automatically available for every agent and provides comprehensive connection information including GUID, API URLs, and code examples.
For an overview of managing all interface types, see Managing Agent Interfaces.
1

Access the Interfaces Panel

Access the interfaces panel by either:
  • Clicking the ellipsis (…) menu to the right of your Agent and selecting Interfaces
  • Opening the Agent in Studio and clicking Settings > Interfaces
2

Access API Interface Details

In the interfaces panel, click View API Info next to the API interface. You will see a window detailing the Agent’s unique identifiers and providing example Agent Execution API calls.
3

Choose Your Code Example Format

Airia provides example API calls in multiple formats including cURL and Python. Select your preferred format using the dropdown menu to get language-specific implementation examples.
4

Configure Your Integration

Use the provided GUID, API URL, and code examples to configure the API interface within your application or system integration.
5

Manage API Keys

API keys are required for authentication. You can manage them directly from the API interface:Click View API Keys from the API interface details Select New API Key to create a new key Enter the API Key Name Define the Scope of this key to the appropriate project Click Create to generate your API Key
6

Test Your API Interface

Test your API interface configuration using your chosen development tool or application. Use the provided code examples as a starting point to verify the agent responds correctly to API calls.

​
Troubleshooting