Add the power of the Box AI API to your custom apps at Content Cloud Summit on May 15

Send AI Ask request

post

https://api.box.com/2.0

/ai/ask

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.

Related Guides

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Body

items object arrayin bodyrequired

The items to be processed by the LLM, often files.

[items].id stringin bodyrequired

example"123"

The id of the item

[items].type stringin bodyrequired

example"file"

The type of the item

Value is always file

[items].content stringin bodyoptional

example"This is file content."

The content of the item, often the text representation.

mode stringin bodyrequired

example"multiple_item_qa"

The mode specifies if this request is for a single or multiple items.

Value is one of multiple_item_qa,single_item_qa

prompt stringin bodyrequired

example"What is the value provided by public APIs based on this document?"

The prompt provided by the client to be answered by the LLM.

Response

200application/jsonAI Response

A successful response including the answer from the LLM.

400application/jsonClient error

An unexpected client error.

500application/jsonClient error

An unexpected server error.

post

Send AI Ask request

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X POST "https://api.box.com/2.0/ai/ask" \
     -H "content-type: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
         "mode": "single_item_qa",
         "prompt": "What is the value provided by public APIs based on this document?",
         "items": [
        {
            "type": "file",
            "id": "9842787262"
        }
       ],
     }'

Java

BoxAIResponse response = BoxAI.sendAIRequest(
    api,
    "What is the content of the file?",
    Collections.singletonList("123456", BoxAIItem.Type.FILE)),
    BoxAI.Mode.SINGLE_ITEM_QA
);

TypeScript (Beta)

await client.ai.createAiAsk({
  mode: 'multiple_item_qa' as AiAskModeField,
  prompt: 'Which direction sun rises?',
  items: [
    new AiAskItemsField({
      id: fileToAsk1.id,
      type: 'file' as AiAskItemsTypeField,
      content: 'Earth goes around the sun',
    }),
    new AiAskItemsField({
      id: fileToAsk2.id,
      type: 'file' as AiAskItemsTypeField,
      content: 'Sun rises in the East in the morning',
    }),
  ],
} satisfies AiAsk);

Python (Beta)

client.ai.create_ai_ask(CreateAiAskMode.MULTIPLE_ITEM_QA.value, 'Which direction sun rises?', [CreateAiAskItems(id=file_to_ask_1.id, type=CreateAiAskItemsTypeField.FILE.value, content='Earth goes around the sun'), CreateAiAskItems(id=file_to_ask_2.id, type=CreateAiAskItemsTypeField.FILE.value, content='Sun rises in the East in the morning')])

.NET (Beta)

await client.Ai.CreateAiAskAsync(requestBody: new AiAsk(mode: AiAskModeField.MultipleItemQa, prompt: "Which direction sun rises?", items: Array.AsReadOnly(new [] {new AiAskItemsField(id: fileToAsk1.Id, type: AiAskItemsTypeField.File, content: "Earth goes around the sun"),new AiAskItemsField(id: fileToAsk2.Id, type: AiAskItemsTypeField.File, content: "Sun rises in the East in the morning")})));

Response Example

{
  "answer": "Public APIs are important because of key and important reasons.",
  "completion_reason": "done",
  "created_at": "2012-12-12T10:53:43-08:00"
}