Overview
This endpoint allows you to create a secure authentication profile for your agent. Think of it as setting up a secure vault of credentials that your agent can access when it needs to interact with external services. Instead of hardcoding API keys or passwords in your agent configuration, you can use this endpoint to store them securely.How it works
- You provide an authentication profile name, agent ID, API key, and a dictionary of authentication data (key-value pairs)
- The system validates that the keys in your auth data match the input arguments defined for your agent
- The system creates an encrypted authentication profile and stores it securely
- You receive an auth token that you can use when running your agent to access this profile
Security features
- Your authentication profile is encrypted before storage
- The encryption key is never stored - only you receive the auth token
- Each auth token is bound to a specific agent_id and cannot be used with different agents
Using the auth token
When you run your agent using the/run_agent
endpoint, you can include the auth token to give your agent access to its authentication profile. The system will automatically decrypt and provide the authentication data to your agent during execution.
Important notes
- The keys in your auth_data must be input arguments defined for your agent
- Store the returned auth_token securely - it cannot be recovered if lost
- Create different authentication profiles as needed for different credential sets or accounts
- Auth tokens can only be used with the specific agent_id they were generated for
Body
application/json
Name of the auth data entry, usually the name of the account or service
Unique identifier for the agent
API key for authentication
Key-value pairs of sensitive authentication data that will be encrypted. Keys must match the agent's defined input arguments.
Response
Authentication data stored successfully
Secure token provided when running the agent to access stored authentication data
Example:
"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY3ODkwYWJjZGVmZ2g="