# Ocoya API Docs

## Docs

- [Welcome](https://docs.ocoya.com/welcome.md): Build social publishing and automation workflows with Ocoya.
- [How to use](https://docs.ocoya.com/get-started.md): Make your first Ocoya REST API request.
- [Authentication](https://docs.ocoya.com/authentication.md): How to authenticate requests to the Ocoya REST API.
- [Rate limits](https://docs.ocoya.com/fundamentals/rate-limits.md): Understand Ocoya API rate limits and response headers.
- [Limitations](https://docs.ocoya.com/fundamentals/limitations.md): Common request constraints for the Ocoya REST API.
- [Me](https://docs.ocoya.com/api-reference/me.md): Returns information about authenticated user.
- [List all owned workspaces](https://docs.ocoya.com/api-reference/list-all-owned-workspaces.md): Returns information about all owned workspaces
- [List all connected social profiles](https://docs.ocoya.com/api-reference/list-all-connected-social-profiles.md): Returns information about all connected social profiles
- [Generate social connection URL](https://docs.ocoya.com/api-reference/generate-social-connection-url.md): Returns a browser URL that starts connecting a social network to a workspace. Open the returned URL while signed in to Ocoya to approve OAuth and select profiles.
- [List brand kits](https://docs.ocoya.com/api-reference/list-brand-kits.md): Returns brand kits in a workspace so you can pass a brand kit ID to AI post or campaign generation.
- [List hashtag libraries](https://docs.ocoya.com/api-reference/list-hashtag-libraries.md): Returns reusable hashtag libraries in a workspace so you can pass a hashtag library ID to AI post or campaign generation.
- [List Studio templates](https://docs.ocoya.com/api-reference/list-studio-templates.md): Returns Studio templates that can be used as visual references for AI-generated posts.
- [List all posts](https://docs.ocoya.com/api-reference/list-all-posts.md): Returns information about all posts
- [Create a scheduled or a draft post](https://docs.ocoya.com/api-reference/create-a-scheduled-or-a-draft-post.md): Returns an id of the post
- [Create an AI-generated draft post](https://docs.ocoya.com/api-reference/create-an-ai-generated-draft-post.md): Generates a post caption from a prompt and creates a draft post. Optionally attaches social profiles, brand kit context, a reusable hashtag library, and one AI-generated image.
- [Create an AI-generated campaign](https://docs.ocoya.com/api-reference/create-an-ai-generated-campaign.md): Queues generation for a multi-post AI campaign and returns immediately with `GENERATING` status. Campaign posts are generated asynchronously in the background.
- [Update post](https://docs.ocoya.com/api-reference/update-post.md): Returns an id of the updated post
- [Delete post](https://docs.ocoya.com/api-reference/delete-post.md): Deletes a post by Post id and cancels all schedules. Returns nothing.
- [List all workflows](https://docs.ocoya.com/api-reference/list-all-workflows.md): Returns information about all workflows
- [List information about the workflow](https://docs.ocoya.com/api-reference/list-information-about-the-workflow.md): Returns information about all workflow steps
- [Toggle workflow on or off](https://docs.ocoya.com/api-reference/toggle-workflow-on-or-off.md): Enables or disables the workflow. Returns nothing.
- [Overview](https://docs.ocoya.com/mcp/get-started.md): Use Ocoya MCP to let AI clients work with approved Ocoya workspaces through OAuth.
- [What is MCP?](https://docs.ocoya.com/mcp/what-is-mcp.md): Learn how Model Context Protocol connects AI clients to approved Ocoya workspace tools.
- [Claude](https://docs.ocoya.com/mcp/connect/claude.md): Connect Claude Code, Claude Desktop, or Claude Web to Ocoya MCP.
- [Codex](https://docs.ocoya.com/mcp/connect/codex.md): Add Ocoya MCP through Codex config or the Codex CLI.
- [VS Code](https://docs.ocoya.com/mcp/connect/vs-code.md): Configure Ocoya MCP for VS Code and GitHub Copilot Agent mode.
- [ChatGPT](https://docs.ocoya.com/mcp/connect/chatgpt.md): Add Ocoya MCP as a custom ChatGPT connector.
- [JSON and stdio clients](https://docs.ocoya.com/mcp/connect/json-clients.md): Configure generic JSON-based MCP clients or bridge stdio-only clients.
- [Troubleshooting](https://docs.ocoya.com/mcp/troubleshooting.md): Fix common Ocoya MCP connection, OAuth, workspace, and tool-call issues.
- [Tools](https://docs.ocoya.com/mcp/tools.md): Complete Ocoya MCP tool reference with parameters, request examples, and return notes.
- [ocoya_get_me](https://docs.ocoya.com/mcp/tools/ocoya-get-me.md): Return the Ocoya user identity associated with the active MCP OAuth grant, including the authorized user id, name, and email.
- [ocoya_list_workspaces](https://docs.ocoya.com/mcp/tools/ocoya-list-workspaces.md): List or search workspaces allowed by the MCP OAuth grant and resolve the workspaceId required by workspace-scoped tools.
- [ocoya_get_workspace](https://docs.ocoya.com/mcp/tools/ocoya-get-workspace.md): Fetch details for one workspace that the MCP OAuth grant is allowed to access.
- [ocoya_list_social_profiles](https://docs.ocoya.com/mcp/tools/ocoya-list-social-profiles.md): List connected social profiles for a workspace so an MCP client can choose the correct target channels before creating or publishing posts.
- [Generate social connection URL](https://docs.ocoya.com/mcp/tools/ocoya-generate-social-connection-url.md): Generate a browser URL that starts the social network connection flow for a workspace.
- [ocoya_get_social_profile](https://docs.ocoya.com/mcp/tools/ocoya-get-social-profile.md): Fetch details for one connected social profile in a workspace after resolving the profile id with ocoya_list_social_profiles.
- [ocoya_list_posts](https://docs.ocoya.com/mcp/tools/ocoya-list-posts.md): List Ocoya post groups for a workspace and optionally filter by status or caption search before opening, updating, scheduling, or deleting posts.
- [ocoya_list_calendar_posts](https://docs.ocoya.com/mcp/tools/ocoya-list-calendar-posts.md): List scheduled calendar posts for a workspace within a date range, using ISO datetimes for the start and end boundaries.
- [ocoya_get_post](https://docs.ocoya.com/mcp/tools/ocoya-get-post.md): Fetch full details for one Ocoya post group in a workspace, including the fields needed before reviewing, updating, scheduling, or deleting it.
- [ocoya_update_post](https://docs.ocoya.com/mcp/tools/ocoya-update-post.md): Update an existing post group in one call, including caption, schedule, publish-now state, brand kit, media, and attached social profiles.
- [ocoya_create_post](https://docs.ocoya.com/mcp/tools/ocoya-create-post.md): Create an Ocoya social post as a draft, schedule it for later, or publish it immediately when publishNow is enabled.
- [ocoya_create_ai_post](https://docs.ocoya.com/mcp/tools/ocoya-create-ai-post.md): Queue a ready-to-edit Ocoya draft from a prompt using the same AI flow as the New AI post composer, with optional brand kit, social profiles, hashtag library, and square image generation.
- [ocoya_create_ai_campaign](https://docs.ocoya.com/mcp/tools/ocoya-create-ai-campaign.md): Start generating a multi-post Ocoya AI campaign and return immediately while background generation continues.
- [ocoya_schedule_post](https://docs.ocoya.com/mcp/tools/ocoya-schedule-post.md): Schedule or reschedule an existing Ocoya post group by assigning a new ISO datetime in an approved workspace.
- [ocoya_delete_post](https://docs.ocoya.com/mcp/tools/ocoya-delete-post.md): Delete an Ocoya post group in an approved workspace and cancel any schedules related to that post group.
- [ocoya_list_brand_kits](https://docs.ocoya.com/mcp/tools/ocoya-list-brand-kits.md): List or search workspace brand kits so posts, AI drafts, and campaigns can use the correct brand context.
- [ocoya_list_hashtag_libraries](https://docs.ocoya.com/mcp/tools/ocoya-list-hashtag-libraries.md): List reusable hashtag libraries in an approved workspace before creating AI drafts or campaigns that should use saved hashtag groups.
- [ocoya_list_studio_templates](https://docs.ocoya.com/mcp/tools/ocoya-list-studio-templates.md): List Studio templates in an approved workspace so AI image generation can follow a saved template style or layout.
- [ocoya_list_workflows](https://docs.ocoya.com/mcp/tools/ocoya-list-workflows.md): List workspace workflows so an MCP client can discover automation ids before inspecting, toggling, or running workflows.
- [ocoya_get_workflow](https://docs.ocoya.com/mcp/tools/ocoya-get-workflow.md): Fetch workflow details and available step options for an Ocoya workflow before inspecting, toggling, or running it.
- [ocoya_toggle_workflow](https://docs.ocoya.com/mcp/tools/ocoya-toggle-workflow.md): Enable or disable an Ocoya workflow after resolving the workflow id and confirming the desired on or off state.
- [ocoya_run_workflow](https://docs.ocoya.com/mcp/tools/ocoya-run-workflow.md): Run an Ocoya workflow immediately through the background automation runner with an optional input payload.

## OpenAPI Specs

- [openapi](https://docs.ocoya.com/openapi.yaml)