Chats - Bevor Documentation

The Bevor SDK is coming soon. This page previews its planned Python interface.

Access this resource from client.chats. Both async and sync clients expose the same methods.

`create`

POST /security/chats/analysis

result = await client.chats.create(
    version_id=version_id,
)

result = client.chats.create(
    version_id=version_id,
)

Parameter	Type	Required	Default
`version_id`	`ID`	Yes	`—`

Returns: IdResponse

`list`

GET /security/chats

result = await client.chats.list()

result = client.chats.list()

Parameter	Type	Required	Default
`page`	`int \| None`	No	`None`
`page_size`	`int \| None`	No	`None`
`project_id`	`ID \| None`	No	`None`
`project_slug`	`str \| None`	No	`None`
`code_version_id`	`ID \| None`	No	`None`
`analysis_id`	`ID \| None`	No	`None`
`chat_type`	`ChatType \| None`	No	`None`
`order_by`	`Literal['created_at', 'updated_at'] \| None`	No	`None`
`order`	`Literal['desc', 'asc'] \| None`	No	`None`

Returns: Pagination[SecurityChatSchema]

`get`

GET /security/chats/{chat_id}

result = await client.chats.get(
    chat_id=chat_id,
)

result = client.chats.get(
    chat_id=chat_id,
)

Parameter	Type	Required	Default
`chat_id`	`ID`	Yes	`—`

Returns: SecurityChatSchema

`update`

PATCH /security/chats/{chat_id}

result = await client.chats.update(
    chat_id=chat_id,
)

result = client.chats.update(
    chat_id=chat_id,
)

Parameter	Type	Required	Default
`chat_id`	`ID`	Yes	`—`
`analysis_id`	`ID \| None`	No	`None`

Returns: BooleanResponse

`messages`

GET /security/chats/{chat_id}/messages

result = await client.chats.messages(
    chat_id=chat_id,
)

result = client.chats.messages(
    chat_id=chat_id,
)

Parameter	Type	Required	Default
`chat_id`	`ID`	Yes	`—`

Returns: ResultsResponse[ChatMessageSchema]

`sync`

POST /security/chats/{chat_id}/sync

result = await client.chats.sync(
    chat_id=chat_id,
    message=message,
)

result = client.chats.sync(
    chat_id=chat_id,
    message=message,
)

Parameter	Type	Required	Default
`chat_id`	`ID`	Yes	`—`
`message`	`str`	Yes	`—`
`is_retry`	`bool`	No	`False`
`attributes`	`List[Dict[str, Any]] \| None`	No	`None`
`approval_id`	`str \| None`	No	`None`
`is_approved`	`bool \| None`	No	`False`

Returns: ChatResponseSchema

`generate_key`

POST /security/chats/{chat_id}/stream-key

result = await client.chats.generate_key(
    chat_id=chat_id,
)

result = client.chats.generate_key(
    chat_id=chat_id,
)

Parameter	Type	Required	Default
`chat_id`	`ID`	Yes	`—`

Returns: str

`stream`

POST /security/chats/{chat_id}/stream

result = await client.chats.stream(
    chat_id=chat_id,
    stream_key=stream_key,
    message=message,
)

result = client.chats.stream(
    chat_id=chat_id,
    stream_key=stream_key,
    message=message,
)

Parameter	Type	Required	Default
`chat_id`	`str`	Yes	`—`
`stream_key`	`str`	Yes	`—`
`message`	`str`	Yes	`—`
`is_retry`	`bool`	No	`False`
`attributes`	`List[Dict[str, Any]] \| None`	No	`None`
`approval_id`	`str \| None`	No	`None`
`is_approved`	`bool \| None`	No	`False`

Returns: Any

​create

​list

​get

​update

​messages

​sync

​generate_key

​stream

`create`

`list`

`get`

`update`

`messages`

`sync`

`generate_key`

`stream`