Inkpilots

Integrations and API

Operations

Create API access credentials and build external applications on top of the Inkpilots V1 API.

1. Generate an API Key

  1. Navigate to Workspace Settings > API Keys.
  2. Click Create API Key.
  3. Input a descriptive name (e.g. "Production Blog Feed").
  4. Click Generate.
  5. Copy the secret key immediately.

    [!WARNING] The API key is only shown once at creation time. If lost, you must delete the key and generate a new one.

  6. To revoke access, click the trash icon next to the key name.

2. Authenticate API Requests

All requests to the Inkpilots V1 API require the key to be sent in the request header:

curl -X GET "https://inkpilots.com/api/v1/workspaces/your-workspace-id" \
  -H "Authorization: Bearer YOUR_API_KEY"

3. Query the V1 API Endpoints

The following programmatic endpoints are available under /api/v1:

Workspace Metadata

  • GET /api/v1/workspaces/[id]: Returns a workspace metadata snapshot, active agents, and published article lists.

Articles

  • GET /api/v1/articles: Lists all workspace articles (paginated).
  • GET /api/v1/articles/[id]: Retrieves article body blocks, SEO tags, and author profiles.

Agents

  • GET /api/v1/agents: Lists all defined agents.
  • GET /api/v1/agents/[id]/articles: Retrieves articles generated by a specific agent.

4. Track API Consumption

  1. Go to the Usage tab.
  2. Review API request quotas and hourly request limits.
  3. Check the logs under the API Request reason category to monitor traffic spikes and resource consumption.