Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Assistants

POST /assistants

Create a new assistant

Create a new assistant with the provided details

    <div class="api-body-section">
            <div class="api-request-body-section">
                <h4>Request Body (application/json)</h4>
                <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">details</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"asst_zbNeYIuXIUSKVHjJkfRo6ilv"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"assistant"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">description</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">model</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"gpt-4"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">instructions</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"You are a helpful assistant, do your best to answer question and query"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">temperature</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">top_p</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>["function","code_interpreter","file_search"]</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tool_resources</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        </div>
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">credential</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"7db93c02-8d5a-4117-a8f1-3dfb6721b339"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">iconSrc</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"/images/assistant.png"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">updatedDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        </div>
            </div>
        </div>
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Assistant created successfully</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">details</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"asst_zbNeYIuXIUSKVHjJkfRo6ilv"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"assistant"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">description</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">model</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"gpt-4"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">instructions</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"You are a helpful assistant, do your best to answer question and query"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">temperature</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">top_p</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>["function","code_interpreter","file_search"]</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tool_resources</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        </div>
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">credential</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"7db93c02-8d5a-4117-a8f1-3dfb6721b339"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">iconSrc</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"/images/assistant.png"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">updatedDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        </div>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">Invalid input provided</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">422</span>
            <span class="api-response-desc">Validation exception</span>
            
        </div>
    </div></div>
</div>
GET /assistants

List all assistants

Retrieve a list of all assistants

    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Successful operation</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">details</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"asst_zbNeYIuXIUSKVHjJkfRo6ilv"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"assistant"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">description</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">model</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"gpt-4"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">instructions</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"You are a helpful assistant, do your best to answer question and query"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">temperature</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">top_p</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>["function","code_interpreter","file_search"]</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tool_resources</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        </div>
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">credential</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"7db93c02-8d5a-4117-a8f1-3dfb6721b339"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">iconSrc</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"/images/assistant.png"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">updatedDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        </div>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>
GET /assistants/{id}

Get assistant by ID

Retrieve a specific assistant by ID

    <div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Assistant ID</td></tr></tbody></table></div>
    
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Successful operation</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">details</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"asst_zbNeYIuXIUSKVHjJkfRo6ilv"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"assistant"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">description</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">model</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"gpt-4"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">instructions</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"You are a helpful assistant, do your best to answer question and query"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">temperature</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">top_p</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>["function","code_interpreter","file_search"]</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tool_resources</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        </div>
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">credential</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"7db93c02-8d5a-4117-a8f1-3dfb6721b339"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">iconSrc</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"/images/assistant.png"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">updatedDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        </div>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Assistant not found</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>
PUT /assistants/{id}

Update assistant details

Update the details of an existing assistant

    <div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Assistant ID</td></tr></tbody></table></div>
    <div class="api-body-section">
            <div class="api-request-body-section">
                <h4>Request Body (application/json)</h4>
                <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">details</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"asst_zbNeYIuXIUSKVHjJkfRo6ilv"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"assistant"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">description</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">model</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"gpt-4"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">instructions</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"You are a helpful assistant, do your best to answer question and query"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">temperature</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">top_p</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>["function","code_interpreter","file_search"]</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 12px;">
                <div class="api-property-meta">
                    <span class="api-property-name">tool_resources</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        </div>
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">credential</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"7db93c02-8d5a-4117-a8f1-3dfb6721b339"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">iconSrc</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"/images/assistant.png"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">updatedDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        </div>
            </div>
        </div>
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Assistant updated successfully</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><span class="api-type-badge">any</span>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid or body is missing</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Assistant not found</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>
DELETE /assistants/{id}

Delete an assistant

Delete an assistant by ID

    <div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Assistant ID</td></tr></tbody></table></div>
    
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Assistant deleted successfully</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Assistant not found</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>