# Create Copilot

POST https://api.credal.ai/api/v0/copilots/createCopilot
Content-Type: application/json

Create a new agent. The API key used will be added to the agent for future Requests

Reference: https://docs.credal.ai/api-reference/api-reference/copilots/create-copilot

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects an object.

- `name` (string, required) — A descriptive name for the agent.
- `description` (string, required) — An in depth name for the agent's function. Useful for routing requests to the right agent.
- `collaborators` (list of Collaborator, required) — A list of collaborator emails and roles that will have access to the agent.

## Response

### 200

- `agentId` (UUID, required)

## Types

### Collaborator

- `email` (string, required)
- `role` (enum, required)
  - Allowed values: `viewer`, `editor`

## Examples

**Request**

```json
{
  "name": "Customer Agent",
  "description": "This agent is used to answer customer requests based on internal documentation.",
  "collaborators": [
    {
      "email": "test@gmail.com",
      "role": "editor"
    }
  ]
}
```

**Response**

```json
{
  "agentId": "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
}
```

**SDK Code**

```typescript Example0
import { CredalClient } from "@credal/sdk";

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.copilots.createCopilot({
        name: "Customer Agent",
        description: "This agent is used to answer customer requests based on internal documentation.",
        collaborators: [
            {
                email: "test@gmail.com",
                role: "editor",
            },
        ],
    });
}
main();

```

```python Example0
from credal import CredalV0
from credal.common import Collaborator

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.copilots.create_copilot(
    name="Customer Agent",
    description="This agent is used to answer customer requests based on internal documentation.",
    collaborators=[
        Collaborator(
            email="test@gmail.com",
            role="editor",
        )
    ],
)

```

## Related pages

- [Credal | Documentation](../index.md)
- [Overview](./api-reference-v-0-overview.md)
- [Docs](../guides.md)
- [Introduction](./getting-started-introduction.md)
- [API Reference](./api-reference-index.md)
- [Service Accounts](./api-reference-v-0-service-accounts.md)
- [Quickstart](./getting-started-quickstart.md)
- [Overview](./api-reference-v-1-overview.md)
- [Overview](./getting-started-tutorials-common-first-agents-employee-onboarding-assistant-overview.md)
- [OAuth Setup](./api-reference-v-1-o-auth-setup.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.