---
title: "Create an intelligence profile"
description: "Creates an `active` intelligence profile owned by the authenticated user with the supplied configuration."
canonical: https://y2.dev/docs/api/reference/profiles/createProfile/
---

Endpoint Reference[Profiles](https://y2.dev/docs/api/reference/profiles)

# Create an intelligence profile

Creates an \`active\` intelligence profile owned by the authenticated user with the supplied configuration.

`POST https://api.y2.dev/api/v1/profiles`

- Operation ID: `createProfile`
- Required scopes: `profiles:write`
- Contract: https://y2.dev/openapi.json

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | string | No | Client-generated retry key retained for 24 hours. Repeating the same key and canonical JSON body returns the original resource. Changing the body returns `409 IDEMPOTENCY_CONFLICT`. |

## Request body

`application/json`: `ProfileCreateRequest` (required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Profile display name |
| `topic` | string | Yes | Topic description for research |
| `frequency` | `FrequencyEnum` | Yes | Report generation frequency |
| `scheduleTimeOfDay` | string | Yes | Time of day for report generation (HH:mm, UTC) |
| `scheduleDayOfWeek` | string | No | Weekday name (case-insensitive) or 0-6 (Sunday-Saturday), required for weekly profiles |
| `scheduleDayOfMonth` | string | No | Day of month for monthly profiles |
| `customPrompt` | string | No | Custom system prompt for the AI analyst |
| `tags[]` | array of string | No | Tags for categorization |
| `isCommunity` | boolean | No | Whether this is a community (public) profile |
| `blufStructure` | string | No | Custom BLUF report structure template |
| `recursionConfig` | `RecursionConfigInput` | No |  |
| `recursionConfig.enabled` | boolean | Yes | When false, runs root-topic research without child subtopics. |
| `recursionConfig.maxDepth` | integer | Yes | Requested child-layer depth. The current runtime defaults an enabled value of `0` to `1` and caps values above `1` at one child layer. This field is ignored when `enabled` is false. |
| `recursionConfig.strategy` | `breadth-first`, `depth-first`, `hybrid` | Yes | Stored strategy preference. The current report engine executes its implemented breadth-first child-search path for every value. |
| `searchConfig` | object | No | Web search configuration |
| `searchConfig.searchDepth` | `basic`, `advanced` | No |  |
| `searchConfig.maxResults` | integer | No |  |
| `searchConfig.timeRange` | string | No |  |
| `searchConfig.topic` | string | No |  |
| `searchConfig.includeDomains[]` | array of string | No |  |
| `searchConfig.excludeDomains[]` | array of string | No |  |
| `modelConfig` | object | No | AI model configuration |
| `modelConfig.modelId` | string | No |  |
| `modelConfig.temperature` | number | No |  |
| `modelConfig.maxOutputTokens` | integer | No |  |
| `budgetConfig` | object | No | Cost budget configuration |
| `budgetConfig.maxCostPerReport` | number | No |  |
| `budgetConfig.alertThreshold` | number | No |  |
| `freshnessConfig` | object | No | Source freshness configuration |
| `freshnessConfig.enabled` | boolean | No |  |
| `freshnessConfig.maxAgeMs` | integer | No |  |
| `freshnessConfig.preferRecentSources` | boolean | No |  |
| `freshnessConfig.recencyWeight` | number | No |  |
| `freshnessConfig.validateLinks` | boolean | No |  |
| `audioConfig` | object | No | Audio generation configuration |
| `audioConfig.enabled` | boolean | No |  |
| `audioConfig.voiceId` | string | No |  |
| `audioConfig.speed` | number | No |  |
| `toolConfig` | object | No | Tool configuration for report generation |
| `brandingTemplateId` | string | No | Branding template ID (paid workspace feature) |

## Responses

| Status | Description | Body |
| --- | --- | --- |
| 201 | Profile created | `ProfileCreateResponse` |
| 400 | Invalid request parameters |  |
| 401 | Missing or invalid API key |  |
| 403 | Insufficient permissions or access denied |  |
| 409 | Resource conflict (e.g., webhook in use) |  |
| 429 | Rate limit exceeded (per-key or per-account aggregate) |  |
| 500 | Internal server error |  |

### 201 response fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | `PublicProfile` |  |
| `data.id` | string |  |
| `data.type` | string |  |
| `data.name` | string |  |
| `data.topic` | string |  |
| `data.status` | `ProfileStatusEnum` | Profile status |
| `data.frequency` | `FrequencyEnum` or null |  |
| `data.schedule` | object |  |
| `data.visibility` | object |  |
| `data.tags[]` | array of string |  |
| `data.customInstructions` | string or null |  |
| `data.reportStructure` | string or null |  |
| `data.configuration` | `PublicProfileConfiguration` |  |
| `data.lastDeliveredAt` | string or null (date-time) |  |
| `data.createdAt` | string (date-time) |  |
| `data.links` | object |  |
| `meta` | object |  |
| `meta.message` | string |  |
