Change Updates

Do not miss any OpenAI API changes, ever again

Subscribe to the OpenAI API changelog to be up to date on recent changes.

RSS

Jun 6, 2024

main
2.0.0
Compare
2.0.0

API structure has changed

Next Change
70 structure changes including:
11 Breaking changes
47 Additions
12 Modifications
11 Removals
Modified 12 Breaking
GET /files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • purpose query parameter Added
GET /files/{file_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Property is now deprecated
        • Property is now required
      • status_details property Modified
        • Property is now deprecated
        • Full types went from object | null to string
POST /audio/transcriptions
  • Body
  • multipart/form-data content type Modified
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
    • timestamp_granularities[] property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CreateTranscriptionResponseVerboseJson alternative Added
POST /audio/translations
  • Body
  • multipart/form-data content type Modified
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • CreateTranslationResponseVerboseJson alternative Added
POST /chat/completions
  • Body
  • application/json content type Modified
    • messages property Modified
      • System message alternative Modified
      • User message, Assistant message, Tool message, Function message alternatives Added
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
    • logit_bias property Modified
      • Additional properties, key properties Added
    • max_tokens property Modified
      • Full types went from integer to integer | null
      • max_tokens property Modified
        • Full types went from integer to integer | null
    • function_call property Modified
      • string-1 alternative Modified
        • Alternative is now deprecated
      • object-2 alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • ChatCompletionFunctionCallOption alternative Added
    • functions property Modified
      • Property is now deprecated
    • logprobs, top_logprobs, response_format, seed, stream_options, tools, tool_choice properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • choices property Modified
      • system_fingerprint property Added
POST /completions
  • Body
  • application/json content type Modified
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
    • prompt property Modified
      • string-1, array-2, array-3, array-4 alternatives Modified
        • Alternatives are now required
          Breaking
    • logit_bias property Modified
      • Additional properties, key properties Added
    • seed, stream_options properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • choices property Modified
      • system_fingerprint property Added
POST /embeddings
  • Body
  • application/json content type Modified
    • input property Modified
      • array-2, array-3, array-4 alternatives Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • array, array, array alternatives Added
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
    • encoding_format, dimensions properties Added
POST /files
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Property is now deprecated
        • Property is now required
      • status_details property Modified
        • Property is now deprecated
        • Full types went from object | null to string
POST /images/edits
  • Body
  • multipart/form-data content type Modified
    • model property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /images/generations
  • Body
  • application/json content type Modified
    • model, quality, style properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /images/variations
  • Body
  • multipart/form-data content type Modified
    • model property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /moderations
  • Body
  • application/json content type Modified
    • model property Modified
      • Combinator is now anyOf
      • string-2 alternative Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results property Modified
Removed 11 Breaking
POST /fine-tunes/{fine_tune_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /fine-tunes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /engines/{engine_id}/search
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /edits
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /classifications
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /answers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /fine-tunes/{fine_tune_id}/events
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /fine-tunes/{fine_tune_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /fine-tunes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /engines/{engine_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /engines
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 47
POST /threads/{thread_id}
POST /threads/{thread_id}/messages
POST /threads/{thread_id}/messages/{message_id}
POST /threads/{thread_id}/runs
POST /threads/{thread_id}/runs/{run_id}
POST /threads/{thread_id}/runs/{run_id}/cancel
POST /threads/{thread_id}/runs/{run_id}/submit_tool_outputs
POST /vector_stores
POST /vector_stores/{vector_store_id}
POST /vector_stores/{vector_store_id}/file_batches
POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
POST /vector_stores/{vector_store_id}/files
POST /threads/runs
GET /threads/{thread_id}/runs
GET /threads/{thread_id}/messages/{message_id}
GET /threads/{thread_id}/messages
GET /threads/{thread_id}
GET /fine_tuning/jobs/{fine_tuning_job_id}/events
GET /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
GET /fine_tuning/jobs/{fine_tuning_job_id}
GET /fine_tuning/jobs
GET /batches/{batch_id}
GET /batches
GET /assistants/{assistant_id}
GET /assistants
DELETE /vector_stores/{vector_store_id}/files/{file_id}
DELETE /vector_stores/{vector_store_id}
DELETE /threads/{thread_id}/messages/{message_id}
DELETE /threads/{thread_id}
DELETE /assistants/{assistant_id}
POST /threads
POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel
POST /fine_tuning/jobs
POST /batches/{batch_id}/cancel
POST /batches
POST /audio/speech
POST /assistants/{assistant_id}
POST /assistants
GET /vector_stores/{vector_store_id}/files/{file_id}
GET /vector_stores/{vector_store_id}/files
GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
GET /vector_stores/{vector_store_id}/file_batches/{batch_id}
GET /vector_stores/{vector_store_id}
GET /vector_stores
GET /threads/{thread_id}/runs/{run_id}/steps/{step_id}
GET /threads/{thread_id}/runs/{run_id}/steps
GET /threads/{thread_id}/runs/{run_id}