Zum Inhalt springen
AcrivaDocs

StartDocumentConversation

POST
/api/v1/t/{tenant}/intelligence/documents/{documentId}/conversations
curl --request POST \
  --url https://example.com/api/v1/t/example/intelligence/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/conversations \
  --header 'Content-Type: application/json' \
  --data '{ "versionNumber": 1 }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

documentId
required
string format: uuid

Request Body

Abschnitt betitelt „Request Body“
Media typeapplication/json
One of:
null
Examplegenerated
{
  "versionNumber": 1
}

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
id
required
string format: uuid
kind
required
Allowed values: Rag Document Assistant
title
required
null | string
documentId
required
null | string format: uuid
versionNumber
required
null | integer format: int32
turnState
required
Allowed values: Open Full VersionSuperseded
createdAt
required
string format: date-time
lastMessageAt
required
string format: date-time
messages
required
Array<object>
object
id
required
string format: uuid
role
required
Allowed values: User Assistant
state
required
Allowed values: Streaming Done Aborted Masked
text
required
null | string
citations
required
Array<object>
object
number
required
integer format: int32
documentId
required
string format: uuid
versionNumber
required
integer format: int32
textRunNumber
required
integer format: int32
start
required
integer format: int32
end
required
integer format: int32
page
required
null | integer format: int32
title
required
string
snippet
required
null | string
toolCalls
required
Array<object> | null
object
id
required
string
name
required
string
state
required
Allowed values: Proposed Executed Declined Failed
tour
One of:
null
createdAt
required
string format: date-time
masked
boolean
acceptsTurns
boolean
Example
{
  "kind": "Rag",
  "turnState": "Open",
  "messages": [
    {
      "role": "User",
      "state": "Streaming",
      "toolCalls": [
        {
          "state": "Proposed"
        }
      ]
    }
  ]
}

201

Abschnitt betitelt „201“

Created

Media typeapplication/json
object
id
required
string format: uuid
kind
required
Allowed values: Rag Document Assistant
title
required
null | string
documentId
required
null | string format: uuid
versionNumber
required
null | integer format: int32
turnState
required
Allowed values: Open Full VersionSuperseded
createdAt
required
string format: date-time
lastMessageAt
required
string format: date-time
messages
required
Array<object>
object
id
required
string format: uuid
role
required
Allowed values: User Assistant
state
required
Allowed values: Streaming Done Aborted Masked
text
required
null | string
citations
required
Array<object>
object
number
required
integer format: int32
documentId
required
string format: uuid
versionNumber
required
integer format: int32
textRunNumber
required
integer format: int32
start
required
integer format: int32
end
required
integer format: int32
page
required
null | integer format: int32
title
required
string
snippet
required
null | string
toolCalls
required
Array<object> | null
object
id
required
string
name
required
string
state
required
Allowed values: Proposed Executed Declined Failed
tour
One of:
null
createdAt
required
string format: date-time
masked
boolean
acceptsTurns
boolean
Example
{
  "kind": "Rag",
  "turnState": "Open",
  "messages": [
    {
      "role": "User",
      "state": "Streaming",
      "toolCalls": [
        {
          "state": "Proposed"
        }
      ]
    }
  ]
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Abschnitt betitelt „404“

Not Found

409

Abschnitt betitelt „409“

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}