Skip to main content
POST
Claim a content gap or brief before writing it

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Body

application/json
agent
string
required

Name shown in Notra while the claim is held, for example "Claude Code".

Required string length: 1 - 80
briefId
string

Brief to claim. A brief planned from a gap shares that gap's claim.

Minimum string length: 1
sourceKind
enum<string>

Kind of gap: gap for a row in promptGaps, search_console for searchGaps, ai_search for aiSearchGaps, prompt for a tracked prompt.

Available options:
gap,
prompt,
search_console,
ai_search
sourceId
string

The gap's id from listGeoContentGaps. Send with sourceKind instead of briefId.

Minimum string length: 1
ttlMinutes
integer
default:30

Minutes until the claim lapses. Defaults to 30. Claim again with the same credentials to renew it.

Required range: 1 <= x <= 240

Response

Claim taken or renewed

sourceKind
enum<string>
required

Kind of the claimed item. manual means a brief that was not planned from a gap.

Available options:
manual,
gap,
prompt,
search_console,
ai_search
sourceId
string
required

Gap id, or the brief id when sourceKind is manual.

agent
string
required

Agent holding the claim.

expiresAt
string
required

ISO timestamp when the claim lapses unless renewed.

organization
object
required

Workspace the request ran in.