YOURAUTOMATION.AI
SYS: OPERATIONALUPTIME: 99.8%

GETTING STARTED

Authentication

The YourAutomation API uses API keys for authentication. Every request must include a valid key in the Authorization header.

API Key Formats

There are two types of API keys, each with a distinct prefix:

PrefixEnvironmentUse Case
ya_live_ProductionLive applications, real data
ya_test_SandboxDevelopment, testing, no charges

Note

Test keys have the same API surface as live keys but do not incur charges. Responses may be cached and are not guaranteed to be unique.

Creating API Keys

Create API keys from your dashboard:

  1. 1.Navigate to Settings > API Keys in your dashboard
  2. 2.Click Create Key and select the environment (live or test)
  3. 3.Assign a descriptive name and select permissions
  4. 4.Copy the key immediately -- it will only be shown once

Using API Keys

TypeScript SDK

TypeScript
import { YourAutomation } from "@yourautomation/sdk"; const client = new YourAutomation({ apiKey: process.env.YA_API_KEY!, });

Python SDK

Python
from yourautomation import YourAutomation client = YourAutomation(api_key=os.environ["YA_API_KEY"])

cURL

cURL
curl https://api.yourautomation.ai/v1/agents \ -H "Authorization: Bearer ya_live_sk_..." \ -H "Content-Type: application/json"

Key Permissions

API keys can be scoped to specific permissions. Available scopes:

ScopeDescriptionDefault
agents:readList and retrieve agentsYes
agents:writeCreate, update, delete agentsYes
agents:executeExecute agents and manage conversationsYes
keys:manageCreate and revoke API keysNo
webhooks:manageCreate and manage webhook endpointsNo
analytics:readAccess usage analytics and metricsYes

Rate Limits

Rate limits vary by plan and are enforced per API key:

PlanRequests/minRequests/day
Starter6010,000
Professional300100,000
EnterpriseCustomUnlimited

When you exceed your rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait.

Security Best Practices

  • -Never hardcode API keys in source code. Use environment variables.
  • -Use test keys for development and CI/CD pipelines.
  • -Rotate keys regularly and revoke any that may have been compromised.
  • -Use minimum scopes -- only grant the permissions each key needs.
  • -Add your .env file to .gitignore to prevent accidental exposure.
  • -Monitor key usage in the dashboard for unusual patterns.