# OYA AI Inc. API

**Canonical:** https://apis.io/apis/getoya-ai/getoya-ai-api/  
**Provider:** OYA AI Inc. — https://apis.io/providers/getoya-ai/  
**Documentation:** https://getoya.ai/llms-full.txt

OYA AI Inc. API is published by [OYA AI Inc.](https://apis.io/providers/getoya-ai/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

OYA AI Inc. API as documented publicly: 26 operations. Contract generated from the documentation by API Evangelist (2026-11-10); not the provider's own document.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/agency/customers` | Account CLI Manage customer sub-accounts from your terminal. |
| POST | `/api/agency/customers` | Account CLI Manage customer sub-accounts from your terminal. |
| GET | `/api/agents` | list user's agents |
| GET | `/api/agents/deleted` | The Deleted tab is backed by GET /api/agents/deleted |
| GET | `/api/agents/{id}/config` | full config (soul, skills, etc.) |
| POST | `/api/agents/{id}/deploy` | compile system prompt + index KB + mark deployed |
| POST | `/api/agents/{id}/restore` | Restoring clears the deletion, brings the OAgent back online, and returns it to your main list |
| POST | `/api/agents/{id}/routines` | create a routine |
| GET | `/api/agents/{id}/runs` | recent runs (max 200, includes `job_id`) |
| GET | `/api/agents/{id}/skills` | skills attached to an agent |
| PUT | `/api/agents/{id}/skills/sync` | replace skill set (idempotent) |
| PUT | `/api/agents/{id}/soul` | update persona / rules / welcome / mission |
| GET | `/api/gateways/{platform}/install-url` | start OAuth or list existing connections |
| POST | `/api/knowledge-base/agents/{id}/knowledge/assign` | assign a KB entry to an agent |
| POST | `/api/knowledge-base/folders/{folderId}/upload` | upload a KB file |
| GET | `/api/me` | Account CLI Manage customer sub-accounts from your terminal. |
| GET | `/api/runs/{jobId}` | Hit GET /api/runs/{job_id} to check status. |
| GET | `/api/skills` | skill catalog |
| POST | `/api/skills/import-folder` | upload a custom skill (multipart) |
| GET | `/api/skills/{id}/export` | download a skill (zip) |
| GET | `/api/templates` | list templates |
| POST | `/api/templates` | Creating a template ( POST /api/templates , or “Save as template” on an agent card) is open to every account , and each one is private to the account that ow... |
| GET | `/api/templates/{id}` | full template payload |
| POST | `/api/triggers/{id}/webhook` | POST /api/triggers/{id}/webhook |
| POST | `/api/v1/chat/completions` | POST /api/v1/chat/completions |
| GET | `/v1/chat/completions` | OpenAI-compatible chat (per agent, via API key) |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/getoya-ai/openapi/_ae-authored/getoya-ai-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-post-api-templates-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-post-api-agency-customers-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-post-api-v1-chat-completions-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-post-api-v1-chat-completions-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-post-api-skills-import-folder-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getoya-ai/json-schema/getoya-ai-put-api-agents-id-skills-sync-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/getoya-ai/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/getoya-ai/getoya-ai-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/getoya-ai/.