Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see Creating metadata templates in the Admin Console or use the metadata template API.
This endpoint also supports Enhanced Extract Agent.
For information about supported file formats and languages, see the Extract metadata from file (structured) API guide.
The access token received from the authorization server in the OAuth 2.0 flow.
AI Extract Structured Request object.
The items to be processed by the LLM. Currently you can use files only.
1 - 25 elementsThe metadata template containing the fields to extract.
For your request to work, you must provide either metadata_template or fields, but not both.
The fields to be extracted from the provided items.
For your request to work, you must provide either metadata_template or fields, but not both.
1The AI agent to be used for the structured extraction. Defaults to the Standard Agent if not specified. If you want to use Enhanced Extract Agent, see Enhanced Extract Agent for details.
A successful response including the answer from the LLM.
AI extract structured response.
AI extract response. The content of this response may vary depending on the requested configuration.
The ISO date formatted timestamp of when the answer to the prompt was created.
"2012-12-12T10:53:43-08:00"
The reason the response finishes.
"done"
The information on the models and processors used in the request.