Azure OpenAI in Microsoft Foundry Models REST API previewreferentie

Dit artikel geeft details over de inferentie REST API-eindpunten voor Azure OpenAI.

API specs

Het beheren en interageren met Azure OpenAI-modellen en -middelen is verdeeld over drie primaire API-oppervlakken:

• Control plane
• Datavlak - authoring
• Datavlak - inferentie

Elke API-oppervlakte/specificatie bevat een andere set Azure OpenAI-mogelijkheden. Elke API heeft zijn eigen unieke set preview- en stabiele/algemeen beschikbare (GA) API-releases. Preview-releases volgen momenteel meestal een maandelijkse cadens.

Authentication

Azure OpenAI biedt twee methoden voor authenticatie. Je kunt API Keys of Microsoft Entra ID gebruiken.

• API-sleutelauthenticatie: Voor dit type authenticatie moeten alle API-verzoeken de API-sleutel in de api-key HTTP-header bevatten. De Quickstart geeft instructies over hoe je met dit type authenticatie oproepen kunt voeren.

• Microsoft Entra ID authenticatie: Je kunt een API-aanroep authenticeren met een Microsoft Entra-token. Authenticatietokens worden opgenomen in een verzoek als header Authorization . Het gegeven token moet voorafgegaan worden door Bearer, bijvoorbeeld Bearer YOUR_AUTH_TOKEN. Je kunt onze handleiding lezen over authenticatie met Microsoft Entra ID.

REST API-versiebeheer

De service-API's zijn versiegevaagd met behulp van de api-version queryparameter. Alle versies volgen de YYYY-MM-DD datumstructuur. For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Datavlak-inferentie

De rest van het artikel behandelt de 2025-04-01-preview preview-release van de Azure OpenAI dataplane inference specification.

Als je op zoek bent naar documentatie over de nieuwste GA API-release, raadpleeg dan de nieuwste GA data plane inference API

Voltooiingen - Creëren

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

Maakt een voltooiing aan voor de gegeven prompt, parameters en gekozen model.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Examples

Example

Maakt een voltooiing aan voor de gegeven prompt, parameters en gekozen model.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Embeddings - Create

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

Verkrijg een vectorrepresentatie van een gegeven invoer die gemakkelijk kan worden gebruikt door machine learning-modellen en algoritmen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Geef de embeddings terug voor een gegeven prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chatvoltooiingen - Aanmaken

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Maakt een voltooiing aan voor het chatbericht

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Examples

Example

Maakt een voltooiing aan voor de gegeven prompt, parameters en gekozen model.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een voltooiing op basis van Azure Search-gegevens en systeem-toegewezen beheerde identiteit.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een voltooiing op basis van Azure Search afbeeldingsvectorgegevens.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een voltooiing op basis van Azure Search vectorgegevens, een eerdere assistent-melding en door de gebruiker toegewezen beheerde identiteit.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een completion aan voor de meegeleverde Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een completion aan voor de verstrekte Mongo DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een voltooiing voor de geleverde Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Maakt een voltooiing voor de geleverde Pinecone-bron.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transcripties - Maak

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Transcribeert audio naar de invoertaal.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 200

Description: OK

Examples

Example

Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde gesproken audiogegevens.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Krijgt getranscribeerde tekst en bijbehorende metadata van de geleverde gesproken audiogegevens.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Reacties: Statuscode: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Vertalingen - Creatie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Transcribeert en vertaalt invoeraudio naar Engelse tekst.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 200

Description: OK

Examples

Example

Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde gesproken audiogegevens.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Reacties: Statuscode: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Krijgt Engelstalige getranscribeerde tekst en bijbehorende metadata van de aangeleverde gesproken audiogegevens.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Reacties: Statuscode: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Spraak - Creëren

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Genereert audio uit de ingevoerde tekst.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 200

Description: OK

Examples

Example

Synthese audio uit de verstrekte tekst.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Reacties: Statuscode: 200

{
  "body": "101010101"
}

Beeldgeneraties - Aanmaken

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Genereert een batch afbeeldingen uit een tekstonderschrift bij een bepaalde beeldgeneratiemodel-implementatie

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: Ok

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Examples

Example

Maakt afbeeldingen aan die een prompt krijgen.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Reacties: Statuscode: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Beeldgeneraties - Bewerken

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Bewerkt een afbeelding van een tekstonderschrift op een gegeven gpt-image-1 modelimplementatie

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: multipart/form-data

Responses

Statuscode: 200

Description: Ok

Statuscode: standaard

Beschrijving: Er is een fout opgetreden.

Lijst - Assistenten

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Geeft een lijst van assistenten terug.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst van assistenten terug.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Create - Assistent

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Maak een assistent met een model en instructies.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een assistent met een model en instructies.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Krijg - Assistent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Haalt een assistent op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een assistent op.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modify - Assistent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Verandert een assistent.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Verandert een assistent.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Verwijderen - Assistent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Verwijder een assistent.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Verwijdert een assistent.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Maak - Thread

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Maak een thread.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maakt een draad.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Get - Thread

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Haalt een draad op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een draad op.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modify - Thread

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Wijzigt een thread.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Wijzigt een thread.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Verwijderen - Thread

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Verwijder een thread.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Verwijdert een thread.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Lijst - Berichten

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Geeft een lijst met berichten terug voor een bepaalde thread.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

List Messages

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Maak aan - Bericht

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Maak een boodschap.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een boodschap.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Ontvang - Bericht

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Haal een bericht op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haal een bericht op.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Wijzigen - Bericht

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Wijzigt een bericht.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Wijzig een bericht.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Maak - Thread En Voer Uit

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Maak een thread aan en voer die in één verzoek uit.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een thread aan en voer die in één verzoek uit.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lijst - Runs

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Geeft een lijst terug van runs die bij een thread horen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst terug van runs die bij een thread horen.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Creëren - Uitvoeren

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Maak een run.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een run.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Ga - Ren

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Haalt een run op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Krijgt een loopje.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Wijzigen - Uitvoeren

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Past een run aan.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Past een run aan.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Verzenden - Tool-uitvoer om uit te voeren

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Wanneer een run de status: "requires_action" en required_action.type heeft submit_tool_outputs, kan dit eindpunt worden gebruikt om de output van de tool-aanroepen te verzenden zodra ze allemaal zijn voltooid. Alle outputs moeten in één verzoek worden ingediend.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Wanneer een run de status: "requires_action" en required_action.type heeft submit_tool_outputs, kan dit eindpunt worden gebruikt om de output van de tool-aanroepen te verzenden zodra ze allemaal zijn voltooid. Alle outputs moeten in één verzoek worden ingediend.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Annuleren - Uitlopen

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Annuleert een run die is in_progress.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Annuleert een run die is in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lijst - Run Steps

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Geeft een lijst van run steps terug die bij een run horen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst van run steps terug die bij een run horen.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Krijg - Run Step

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Haalt een run step op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een run step op.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lijst - Vector Stores

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Geeft een lijst van vectorwinkels terug.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst van vectorwinkels terug.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Create - Vector Store

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Maak een vectoropslag aan.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maakt een vectoropslag aan.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Haal - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Haalt een vectoropslag op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een vectoropslag op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Wijzigen - Vector Store

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Wijzigt een vector store.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Wijzigt een vector store.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Verwijderen - Vector Store

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Verwijder een vectorstore.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Verwijdert een vector store.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Lijst - Vector Store-bestanden

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Geeft een lijst van vector store-bestanden terug.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst van vector store-bestanden terug.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - Vector Store-bestand

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Maak een vector store-bestand aan door een bestand aan een vectorstore toe te voegen.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een vector store-bestand aan door een bestand aan een vectorstore toe te voegen.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Reacties: Statuscode: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Haal - Vector Store-bestand

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Haalt een vector store-bestand op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een vector store-bestand op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Verwijderen - Vector Store-bestand

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Verwijder een vector store-bestand. Dit verwijdert het bestand uit de vectorstore, maar het bestand zelf wordt niet verwijderd. Om het bestand te verwijderen, gebruik je het delete-file endpoint.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Verwijder een vector store-bestand. Dit verwijdert het bestand uit de vectorstore, maar het bestand zelf wordt niet verwijderd. Om het bestand te verwijderen, gebruik je het delete-file endpoint.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Werk attributen bij op een vector store-bestand.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Haal de inhoud van vector store-bestanden op

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Haal de geparsde inhoud van een vector store-bestand op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Zoekvectoropslag

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Zoek in een vectoropslag naar relevante chunks op basis van een query- en bestandsattributenfilter.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Create - Vector Store File Batch

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Maak een batch van een vector store-bestand.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Examples

Example

Maak een batch van een vector store-bestand.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Reacties: Statuscode: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - Vector Store File Batch

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Haalt een vector store-bestandbatch op.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Haalt een vector store-bestandbatch op.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Annuleren - Vector Store Bestandsbatch

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Annuleer een batch van een vector store-bestand. Dit probeert de verwerking van bestanden in deze batch zo snel mogelijk te annuleren.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Annuleer een batch van een vector store-bestand. Dit probeert de verwerking van bestanden in deze batch zo snel mogelijk te annuleren.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lijst - Vector Store File Batchbestanden

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Geeft een lijst van vector store-bestanden in een batch terug.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Examples

Example

Geeft een lijst van vector store-bestanden terug.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Reacties: Statuscode: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Maak een vluchtig API-token aan voor gebruik in client-side applicaties met de Realtime API. Kan worden geconfigureerd met dezelfde sessieparameters als het session.update client-event. Het reageert met een sessieobject, plus een client_secret sleutel die een bruikbaar vluchtig API-token bevat dat gebruikt kan worden om browserclients voor de Realtime API te authenticeren.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Beschrijving: Sessie succesvol aangemaakt.

Aanmaken - Transcriptionrealtimesessie

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Maak een vluchtig API-token aan voor gebruik in client-side applicaties met de Realtime API, specifiek voor realtime transcripties. Kan worden geconfigureerd met dezelfde sessieparameters als het transcription_session.update client-event. Het reageert met een sessieobject, plus een client_secret sleutel die een bruikbaar vluchtig API-token bevat dat gebruikt kan worden om browserclients voor de Realtime API te authenticeren.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Beschrijving: Sessie succesvol aangemaakt.

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Maakt een modelrespons.

Request Body

Content-Type: application/json

Responses

Statuscode: 200

Description: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Responses API - invoeritems

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Haalt een modelantwoord op met de gegeven ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Delete response

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Verwijdert een modelantwoord met de gegeven ID.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Statuscode: 404

Beschrijving: Niet gevonden

Statuscode: standaard

Beschrijving: Dienst niet beschikbaar

Responses API - lijst met antwoorditems

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Geeft een lijst van invoeritems terug voor een gegeven respons.

URI Parameters

Request Header

Gebruik ofwel tokengebaseerde authenticatie of API-sleutel. Authenticatie met tokengebaseerde authenticatie wordt aanbevolen en is veiliger.

Responses

Statuscode: 200

Description: OK

Components

errorResponse

errorBase