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

Send AI Text Gen request

post

https://api.box.com/2.0

/ai/text_gen

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Related Guides

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Body

dialogue_history object arrayin bodyoptional

The history of prompts and answers previously passed to the LLM. This provides additional context to the LLM in generating the response.

[dialogue_history].answer stringin bodyoptional

example"Here is the first draft of your professional email about public APIs."

The answer previously provided by the LLM.

[dialogue_history].created_at string (date-time)in bodyoptional

example"2012-12-12T10:53:43-08:00"

The ISO date formatted timestamp of when the previous answer to the prompt was created.

[dialogue_history].prompt stringin bodyoptional

example"Make my email about public APIs sound more professional."

The prompt previously provided by the client and answered by the LLM.

items object arrayin bodyrequired

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

[items].id stringin bodyoptional

example"123"

The id of the item.

[items].type stringin bodyoptional

example"file"

The type of the item.

Value is always file

[items].content stringin bodyoptional

example"This is file content."

The content to use as context for generating new text or editing existing text.

prompt stringin bodyrequired

example"Write an email to a client about the importance of public APIs."

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 Text Gen 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/text_gen" \
     -H "content-type: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
         "prompt": "Write an email to a client about the importance of public APIs.",
         "items": [
        {
            "id": "12345678",
            "type": "file",
            "content": "More information about public APIs"
        },
        {
            "id": "87654321",
            "type": "file",
        },
    ],
    "dialogue_history": [
        {
            "prompt": "Make my email about public APIs sound more professional",
            "answer": "Here is the first draft of your professional email about public APIs",
            "created_at": "2013-12-12T10:53:43-08:00"
        },
        {
            "prompt": "Can you add some more information?",
            "answer": "Public API schemas provide necessary information to integrate with APIs...",
            "created_at": "2013-12-12T11:20:43-08:00"
        }
    ],
  }'

Java

List<BoxAIDialogueEntry> dialogueHistory = new ArrayList<>();
dialogueHistory.add(
        new BoxAIDialogueEntry(
            "Make my email about public APIs sound more professional",
            "Here is the first draft of your professional email about public APIs.",
            BoxDateFormat.parse("2013-05-16T15:26:57-07:00")
        )
    );
BoxAIResponse response = BoxAI.sendAITextGenRequest(
    api,
    "Write an email to a client about the importance of public APIs.",
    Collections.singletonList(new BoxAIItem("123456", BoxAIItem.Type.FILE)),
    dialogueHistory
);

TypeScript (Beta)

await client.ai.createAiTextGen({
  prompt: 'Parapharse the document.s',
  items: [
    {
      id: fileToAsk.id,
      type: 'file' as AiTextGenItemsTypeField,
      content:
        'The Earth goes around the sun. Sun rises in the East in the morning.',
    } satisfies AiTextGenItemsField,
  ],
  dialogueHistory: [
    {
      prompt: 'What does the earth go around?',
      answer: 'The sun',
      createdAt: dateTimeFromString('2021-01-01T00:00:00Z'),
    } satisfies AiTextGenDialogueHistoryField,
    {
      prompt: 'On Earth, where does the sun rise?',
      answer: 'East',
      createdAt: dateTimeFromString('2021-01-01T00:00:00Z'),
    } satisfies AiTextGenDialogueHistoryField,
  ],
} satisfies AiTextGen);

Python (Beta)

client.ai.create_ai_text_gen('Parapharse the document.s', [CreateAiTextGenItems(id=file_to_ask.id, type=CreateAiTextGenItemsTypeField.FILE.value, content='The Earth goes around the sun. Sun rises in the East in the morning.')], dialogue_history=[CreateAiTextGenDialogueHistory(prompt='What does the earth go around?', answer='The sun', created_at=date_time_from_string('2021-01-01T00:00:00Z')), CreateAiTextGenDialogueHistory(prompt='On Earth, where does the sun rise?', answer='East', created_at=date_time_from_string('2021-01-01T00:00:00Z'))])

.NET (Beta)

await client.Ai.CreateAiTextGenAsync(requestBody: new AiTextGen(prompt: "Parapharse the document.s", items: Array.AsReadOnly(new [] {new AiTextGenItemsField(id: fileToAsk.Id, type: AiTextGenItemsTypeField.File, content: "The Earth goes around the sun. Sun rises in the East in the morning.")}), dialogueHistory: Array.AsReadOnly(new [] {new AiTextGenDialogueHistoryField(prompt: "What does the earth go around?", answer: "The sun", createdAt: Utils.DateTimeFromString(dateTime: "2021-01-01T00:00:00Z")),new AiTextGenDialogueHistoryField(prompt: "On Earth, where does the sun rise?", answer: "East", createdAt: Utils.DateTimeFromString(dateTime: "2021-01-01T00:00:00Z"))})));

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"
}