Skip to content

assistant_create_params

Classes:

Name Description
AssistantCreateParams

AssistantCreateParams

Attributes:

Name Type Description
description Optional[str]

The description of the assistant. The maximum length is 512 characters.

file_ids List[str]

A list of file IDs

instructions Optional[str]

The system instructions that the assistant uses.

metadata Optional[object]

Set of 16 key-value pairs that can be attached to an object.

model Required[str]

ID of the model to use.

name Optional[str]

The name of the assistant. The maximum length is 256 characters.

tools Iterable[AssistantToolParam]

A list of tool enabled on the assistant.

description instance-attribute

description: Optional[str]

The description of the assistant. The maximum length is 512 characters.

file_ids instance-attribute

file_ids: List[str]

A list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

instructions instance-attribute

instructions: Optional[str]

The system instructions that the assistant uses.

The maximum length is 32768 characters.

metadata instance-attribute

metadata: Optional[object]

Set of 16 key-value pairs that can be attached to an object.

This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

model instance-attribute

model: Required[str]

ID of the model to use.

You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

name instance-attribute

name: Optional[str]

The name of the assistant. The maximum length is 256 characters.

tools instance-attribute

A list of tool enabled on the assistant.

There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.