Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.writer.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide helps you create and manage API keys for the Writer API. To create and manage API keys, you must be logged in to AI Studio.

​
About API keys

The Writer API uses token authentication for API requests. API keys are used as tokens, which you pass in the Authorization header of your requests: 
Authorization: Bearer <api-key>

​
API agents and API keys

Writer API keys are attached to AI Studio API agents. API capabilities are set at the agent level. Within an API-based agent, you can create multiple API keys that share the capabilities of the agent. To create keys with different capabilities, create multiple API agents. Each API key can be scoped to All teams or a Specific team within your organization. Team scoping controls which team can use a given key, while the agent’s capabilities determine which API endpoints the key can access.

​
Create an API agent

  1. From the AI Studio home page, open Admin settings in the navigation menu, then select API Keys.
  2. Click Create API agent in the top right corner of the page.
  3. When the agent opens, select the title field to rename the agent, and enter a short description so you can recognize what the agent is for.

​
Create an API key

Each API agent has a default API key, called Production. To create additional API keys:
  1. Navigate to the API application. From the AI Studio home page, click Admin Settings in the navigation menu, then select API Keys.
  2. Click the API agent’s tile you want to generate a new key for.
  3. Click Generate a new key.
  4. Configure the new key with the following fields:
    • API key name: A descriptive name to help you identify the key.
    • Who can use this API key by default: Select All teams to make the key available to every team in your organization, or Specific team to restrict access to a single team. If you select Specific team, two additional fields appear:
      • Team with immediate access: Choose the team that can use this key from the dropdown.
      • Key owner: Assign an owner responsible for managing the key.
  5. Click Generate a new key to create the key.
  6. Immediately after generating the key, copy the key and save it securely. You can’t view the key again after you navigate away from this page.
Store the API key in a secure location, such as a .env file (for example, WRITER_API_KEY=<API_KEY>). If you lose a key, revoke it and generate a new one—you can’t recover the original secret.

​
See your API agents and manage API keys

  1. From the AI Studio home page, open Admin settings → API Keys.
  2. In the table, open an agent’s row to go to that agent.
You can’t view or reveal the full API key after it’s created. Copy it the first time it’s shown and store it securely. To replace a lost key, generate a new key from the API agent page.

​
Manage API agent capabilities

API capabilities are set at the agent level and apply to all keys within that agent. To manage API agent capabilities:
  1. From the AI Studio home page, click Admin Settings in the navigation menu, then select API Keys.
  2. Click an individual agent’s tile to navigate to the agent.
  3. Under Capabilities, toggle to enable or turn off a specific capability for the agent.
Capabilities map to Writer API endpoints. Click Read more in the API Documentation column to learn more about the specific endpoints.

​
Delete an API agent

To delete an API agent:
  1. From the AI Studio home page, open Admin settings → API Keys.
  2. On the row for the agent you want to remove, open the Actions menu, then select Delete.
  3. Confirm the deletion by clicking Delete.

​
Delete an API key

To delete an API key:
  1. From the AI Studio home page, open Admin settings → API Keys.
  2. Open the agent in the table, then stay on the Manage keys tab.
  3. On the row for the key you want to remove, open the Actions menu, then select Revoke.
  4. Confirm by clicking Revoke key.

​
Next steps