Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Create content provenance check

content_provenance_checks.create(**kwargs) -> ContentProvenanceCheck { created_at, object, results }
POST/content_provenance_checks

Check whether an image or audio file contains known OpenAI provenance signals. Learn more about content provenance.

If not_detected, it means the tool did not find supported signals in the uploaded file. The content could still have been generated by OpenAI if the metadata was stripped or has evidence of tampering, the watermark was degraded, it comes from a legacy generation model, or it was created before provenance signals were available. Content could also still be AI-generated by another company’s model, which the tool currently does not detect.

ParametersExpand Collapse
file: FileInput

The image or audio file to check for supported OpenAI provenance signals.

ReturnsExpand Collapse
class ContentProvenanceCheck { created_at, object, results }
created_at: Integer

The Unix timestamp, in seconds, when the provenance check was created.

formatunixtime
object: :content_provenance_check

The object type. Always content_provenance_check for this endpoint.

results: Array[C2PA{ generated_at, issuer, model, 3 more} | SynthID{ generated_at, model, outcome, type}]

The provenance results that apply to the uploaded file. Image results include C2PA and SynthID; audio results include SynthID.

Create content provenance check

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

content_provenance_check = openai.content_provenance_checks.create(file: StringIO.new("Example data"))

puts(content_provenance_check)
{
  "created_at": 0,
  "object": "content_provenance_check",
  "results": [
    {
      "generated_at": "generated_at",
      "issuer": "issuer",
      "model": "model",
      "outcome": "detected",
      "type": "c2pa",
      "validation_state": "trusted"
    }
  ]
}
Returns Examples
{
  "created_at": 0,
  "object": "content_provenance_check",
  "results": [
    {
      "generated_at": "generated_at",
      "issuer": "issuer",
      "model": "model",
      "outcome": "detected",
      "type": "c2pa",
      "validation_state": "trusted"
    }
  ]
}