> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycpedia.org/llms.txt
> Use this file to discover all available pages before exploring further.

# For agents

> Find machine-readable documentation and integrate without guessing endpoints or credit usage.

Use these resources on this documentation site:

* [llms.txt](https://docs.ycpedia.org/llms.txt): page index with descriptions.
* [llms-full.txt](https://docs.ycpedia.org/llms-full.txt): full documentation text.
* [OpenAPI specification](/openapi.json): endpoints, authentication, and schemas.
* Append `.md` to a documentation page URL for Markdown.

Mintlify also provides a documentation search MCP endpoint at `https://docs.ycpedia.org/mcp`. It searches documentation; API requests still require your customer key and API base URL.

## Integration rules

1. Obtain the API origin and customer key from the team. Do not use the docs domain as the API origin.
2. Read `/api/v1/credits` for the balance and account-specific terms and limits.
3. Use a LinkedIn slug to identify the profile. No tag filter is needed.
4. Preserve the same `Idempotency-Key` when retrying a generation or update request.
5. Handle both generation responses: `200` with an article, or `202` with a job ID.
6. Poll the job for free until `succeeded`, `failed`, or `cancelled`. Use its included result.
7. Keep keys out of prompts, logs, browser code, and committed files.
