Skip to main content
Use these resources on this documentation site: 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. Generate creates new articles: handle 202 with a job ID, or 409 with code: article_exists and zero charge. For an existing article, explicitly choose GET to read (1 credit) or POST update for fresh research (100 credits). Do not automatically update without the customer’s intent. Replaying an accepted terminal job returns 200 with its original result.
  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.