Developers

REST API Reference

Use these entry points to work with the Medialyst API.

1. Get An API Key

Create API keys from the Medialyst Developers page. The _ segment resolves to your current organization.

Give each key a clear name, choose the smallest useful scopes, copy the raw key immediately, and store it in secret storage or an environment variable such as MEDIALYST_API_KEY.

Send the key as a bearer token on API requests:

Authorization: Bearer <YOUR_API_KEY>

Keep keys private

Medialyst only shows the raw API key once. Do not paste keys into prompts, commit them to source control, or share screenshots that reveal them.

2. Automated Media Lists

Follow the Automated Media Lists guide to choose between an approval-gated browser deep link and a fully automated API job. The guide covers creating a researched journalist list, polling its background job, retrieving normalized results, and finding API-created lists in the Medialyst app.

3. Enrich Journalists

POST /api/v1/journalists/enrich accepts known journalist references as well as article URLs. The canonical reference request is:

{
  "from": [
    {
      "type": "journalist_reference",
      "name": "Jane Doe",
      "publication": "The Daily Example"
    }
  ]
}

For every journalist_reference, name requires at least one of publication, domain, or url. Use article_url with a real article URL when you want to enrich that article's author; both source types can be mixed in the same from array.

Enrichment is asynchronous. The create request returns a durable job id immediately. Poll GET /api/v1/journalist-enrichment-jobs/{jobId} until its status is complete or failed. The deprecated create-call fields options.wait and options.timeout_ms do not change this workflow.

4. API Documentation

Browse the interactive API documentation at /api/docs.

5. Agent-Readable OpenAPI Reference

Use the raw OpenAPI document at /api/open-api.