Methods

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

topic path

Identifier (ULID).

Body application/json

• operation object required

  one of modify remove make_optional make_mandatory

• patch array<object> | null
• patch.title string

  length: at most 255

• patch.description string

  length: at most 4000

• patch.depth object

  one of overview standard deep

• patch.opening_questions array<string>

  items: at most 20

• patch.information_targets array<object>

  items: at most 20

• patch.information_targets[].key string required
• patch.information_targets[].label string required

  length: at most 255

• patch.demonstrations array<string>

  items: at most 20

• patch.forbidden_subjects array<string>

  items: at most 20

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

topic path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

proposal path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

proposal path

Identifier (ULID).

Body application/json

• keys array<string> required

  items: at least 1

• edits array<array<object>>
• edits[].title string

  length: at most 255

• edits[].requirement object

  one of mandatory optional

• edits[].depth object

  one of overview standard deep

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

Body application/json

• count integer

  at least 3 at most 12

• focus string | null

  length: at most 1000

• locale string | null

  one of en fr

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

Body application/json

• key string | null
• title string required

  length: at most 255

• description string | null

  length: at most 4000

• requirement object

  one of mandatory optional

• depth object

  one of overview standard deep

• opening_questions array<string>

  items: at most 20

• information_targets array<object>

  items: at most 20

• information_targets[].key string required
• information_targets[].label string required

  length: at most 255

• demonstrations array<string>

  items: at most 20

• forbidden_subjects array<string>

  items: at most 20

• deliverable_category string | null

  length: at most 64

• position integer

  at least 0

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

Body application/json

• ids array<string> required

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

topic path

Identifier (ULID).

Body application/json

• key string | null
• title string

  length: at most 255

• description string | null

  length: at most 4000

• requirement object

  one of mandatory optional

• depth object

  one of overview standard deep

• opening_questions array<string>

  items: at most 20

• information_targets array<object>

  items: at most 20

• information_targets[].key string required
• information_targets[].label string required

  length: at most 255

• demonstrations array<string>

  items: at most 20

• forbidden_subjects array<string>

  items: at most 20

• deliverable_category string | null

  length: at most 64

• position integer

  at least 0

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

ownerType path

Value from a fixed list (type, language, level…).

ownerId path

Identifier (ULID).

topic path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Body application/json

• name string required

  length: at most 255

• description string | null

  length: at most 2000

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

name path

Value from a fixed list (type, language, level…).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Body application/json

• template_key string required
• name string | null

  length: at most 255

• locale string | null

  one of en fr

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

Body application/json

• name string required

  length: at most 255

• description string | null

  length: at most 2000

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

Responses

• 204 Deleted, no content.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

version path

Identifier (ULID).

cursor limit query

Cursor pagination, for operations that return a paginated list.

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

version path

Identifier (ULID).

Body application/json

• objectives string | null

  length: at most 10000

• interviewer_instructions string | null

  length: at most 10000

• posture array<object>
• posture.register array<object>

  one of vous tu neutral

• posture.use_first_name boolean
• posture.formality object

  one of relaxed standard formal

• posture.warmth object

  one of reserved standard warm

• posture.probing object

  one of light standard insistent

• posture.silence_threshold_ms integer

  at least 400 at most 5000

• posture.allow_suggestions boolean
• persona array<object>
• persona.name string required

  length: at most 60

• persona.avatar_preset object

  one of classic short_hair glasses curly bun beard

• persona.voice string | null

  length: at most 128

• welcome_screen array<array<object>>
• welcome_screen[].title string | null

  length: at most 255

• welcome_screen[].intro string | null

  length: at most 2000

• welcome_screen[].accept_label string | null

  length: at most 255

• welcome_screen[].highlights array<string | null>

  items: at most 6

• welcome_screen[].blocks array<object>
• welcome_screen[].blocks.custom array<object>

  items: at most 6

• welcome_screen[].blocks.custom[].title string | null

  length: at most 255

• welcome_screen[].blocks.custom[].body string | null

  length: at most 4000

• welcome_screen[].blocks[].title string | null

  length: at most 255

• welcome_screen[].blocks[].body string | null

  length: at most 4000

• deliverable_schema array<object>
• deliverable_schema.sections array<object>
• deliverable_schema.sections[].key object required

  one of summary process_map findings contradictions opportunities recommendations tools

• deliverable_schema.sections[].enabled boolean required
• deliverable_schema.finding_categories array<object>

  items: at most 30

• deliverable_schema.finding_categories[].key string required
• deliverable_schema.finding_categories[].label array<string | null> required
• deliverable_schema.finding_categories[].description array<string | null>
• deliverable_schema.opportunity_categories array<object>

  items: at most 30

• deliverable_schema.opportunity_categories[].key string required
• deliverable_schema.opportunity_categories[].label array<string | null> required
• deliverable_schema.opportunity_categories[].description array<string | null>
• deliverable_schema.priority_scale array<object>

  items: at most 6

• deliverable_schema.priority_scale[].key string required

  length: at most 32

• deliverable_schema.priority_scale[].label array<string | null> required
• deliverable_schema.priority_scale[].rule string required

  length: at most 255

Responses

• 200 Success: the resource in data.
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

version path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

version path

Identifier (ULID).

Body multipart/form-data

• avatar file required

  length: at most 2048

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.

Parameters

method path

Identifier (ULID).

version path

Identifier (ULID).

Responses

• 201 Created (200 or 202 for an action or an asynchronous job).
• 401 Missing, invalid, revoked or expired token.
• 403 Not allowed by the role, a rule or the scope.
• 404 Unknown resource or outside the workspace.
• 422 Invalid data (validation.failed).
• 429 Rate limit reached.