Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 33 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ curl -i -X POST "https://api.box.com/oauth2/token" \
<!-- sample post_ai_ask-->

```bash
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
curl -i -L -X POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
Expand Down Expand Up @@ -183,7 +183,7 @@ curl -i -L POST "https://api.box.com/2.0/ai/ask" \
<!-- sample post_ai_ask_extended-->

```bash
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
curl -i -L -X POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
Expand Down Expand Up @@ -283,7 +283,7 @@ curl -i -L POST "https://api.box.com/2.0/ai/ask" \
<!-- sample post_ai_text_gen-->

```bash
curl -i -L POST "https://api.box.com/2.0/ai/text_gen" \
curl -i -L -X POST "https://api.box.com/2.0/ai/text_gen" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
Expand Down Expand Up @@ -316,7 +316,7 @@ curl -i -L POST "https://api.box.com/2.0/ai/text_gen" \
<!-- sample post_ai_text_gen_extended-->

```bash
curl -i -L POST "https://api.box.com/2.0/ai/text_gen" \
curl -i -L -X POST "https://api.box.com/2.0/ai/text_gen" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
Expand Down Expand Up @@ -373,7 +373,7 @@ curl -i -L POST "https://api.box.com/2.0/ai/text_gen" \
<!-- sample get_ai_agent_default -->

```bash
curl -L GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
curl -L -X GET "https://api.box.com/2.0/ai_agent_default?mode=text_gen" \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
```

Expand All @@ -384,8 +384,8 @@ Creates custom AI agents.
<!-- sample post-ai-agents -->

```bash
curl -L POST "https://api.box.com/2.0/ai-agents" \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
curl -L -X POST "https://api.box.com/2.0/ai-agents" \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-d '{
type:
type: string
Expand Down Expand Up @@ -427,7 +427,7 @@ curl -L POST "https://api.box.com/2.0/ai-agents" \
<!-- sample delete_ai_agents_id -->

```bash
curl -L DELETE "https://api.box.com/2.0/ai_agents/12345" \
curl -L -X DELETE "https://api.box.com/2.0/ai_agents/12345" \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
```

Expand Down Expand Up @@ -682,7 +682,7 @@ curl -L 'https://api.box.com/2.0/docgen_templates' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-D '{
-d '{
"file": {
"id": "12345678",
"type": "file"
Expand Down Expand Up @@ -748,7 +748,7 @@ curl -L 'https://api.box.com/2.0/docgen_templates/12345678/tags' \
curl -L 'https://api.box.com/2.0/docgen_batches' \
-H 'box-version: 2025.0' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-D '{
-d '{
"file": {
"id": "12345678",
"type": "file"
Expand Down Expand Up @@ -814,8 +814,8 @@ curl -L 'https://api.box.com/2.0/docgen_batches' \
}
}
}
]`

]
}'
```

## Get all Doc Gen jobs
Expand Down Expand Up @@ -1524,7 +1524,7 @@ curl -i -X PUT "https://api.box.com/2.0/folders/4353455" \
"name": "New folder name",
"parent": {
"id": "123"
}
},
"owned_by": {
"id": "123456"
}
Expand Down Expand Up @@ -2866,7 +2866,7 @@ Uploads or updates a user avatar.
<!-- sample post_users_id_avatar -->

```bash
curl -i -X -L POST "https://api.box.net/2.0/users/12345/avatar" \
curl -i -L -X POST "https://api.box.com/2.0/users/12345/avatar" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
--form 'pic=@"path/to/file/file.jpeg"'
```
Expand All @@ -2878,7 +2878,7 @@ Deletes a user avatar.
<!-- sample delete_users_id_avatar -->

```bash
curl -i -X DELETE -L "https://api.box.net/2.0/users/12345/avatar" \
curl -i -X DELETE -L "https://api.box.com/2.0/users/12345/avatar" \
-H "authorization: Bearer <ACCESS_TOKEN>"
```

Expand Down Expand Up @@ -3483,7 +3483,7 @@ curl -i -X POST "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCa
curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json-patch+json" \
-d '[
-d '[{
"op": "replace",
"path": "/cards/0",
"value": {
Expand All @@ -3506,7 +3506,7 @@ curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCar
{ "text": "DN86 BOX" }
}
}
]'
}]'
```

## Delete Skill cards from file
Expand Down Expand Up @@ -4420,7 +4420,7 @@ curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==n
<!-- sample get_zip_downloads_id_content -->

```bash
curl -L GET "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content" \
curl -L -X GET "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-o sample_curl.zip
```
Expand Down Expand Up @@ -4996,11 +4996,10 @@ curl -i -X POST "https://api.box.com/2.0/users/terminate_sessions" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-H "accept: application/json" \
-d
{
user_ids: ["6178859178", "4824866571"]
user_logins: ["user@example.com", "user2@example.com",]
}
-d '{
"user_ids": ["6178859178", "4824866571"],
"user_logins": ["user@example.com", "user2@example.com"]
}'
```

## Terminate groups sessions
Expand All @@ -5012,18 +5011,17 @@ curl -i -X POST "https://api.box.com/2.0/groups/terminate_sessions" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-H "accept: application/json" \
-d
{
  "group_ids": ["6178859178", "4824866571"],
}
-d '{
"group_ids": ["6178859178", "4824866571"]
}'
```

## List integration mappings Slack

<!-- sample get_integration_mappings_slack -->

```bash
curl -X -L GET "https://api.box.com/2.0/integration_mappings/slack?partner_item_id=C987654321&box_item_id=123456789" \
curl -L -X GET "https://api.box.com/2.0/integration_mappings/slack?partner_item_id=C987654321&box_item_id=123456789" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
```

Expand All @@ -5032,7 +5030,7 @@ curl -X -L GET "https://api.box.com/2.0/integration_mappings/slack?partner_item_
<!-- sample post_integration_mappings_slack -->

```bash
curl -X -L POST "https://api.box.com/2.0/integration_mappings/slack" \
curl -L -X POST "https://api.box.com/2.0/integration_mappings/slack" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H 'content-type: application/json' \
-d '{
Expand All @@ -5053,7 +5051,7 @@ curl -X -L POST "https://api.box.com/2.0/integration_mappings/slack" \
<!-- sample put_integration_mappings_slack_id -->

```bash
curl -X -L PUT "https://api.box.com/2.0/integration_mappings/slack/512521" \
curl -L -X PUT "https://api.box.com/2.0/integration_mappings/slack/512521" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H 'content-type: application/json' \
-d'{
Expand All @@ -5068,7 +5066,7 @@ curl -X -L PUT "https://api.box.com/2.0/integration_mappings/slack/512521" \
<!-- sample delete_integration_mappings_slack_id -->

```bash
curl -X -L DELETE "https://api.box.com/2.0/integration_mappings/slack/512521" \
curl -L -X DELETE "https://api.box.com/2.0/integration_mappings/slack/512521" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d ''
```
Expand Down Expand Up @@ -5106,7 +5104,7 @@ curl -X GET -L "https://api.box.com/2.0/integration_mappings/teams" \
<!-- sample post_integration_mappings_teams -->

```bash
curl -X -L POST "https://api.box.com/2.0/integration_mappings/teams" \
curl -L -X POST "https://api.box.com/2.0/integration_mappings/teams" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H 'content-type: application/json' \
-d '{
Expand All @@ -5128,7 +5126,7 @@ curl -X -L POST "https://api.box.com/2.0/integration_mappings/teams" \
<!-- sample put_integration_mappings_teams_id -->

```bash
curl -X -L PUT "https://api.box.com/2.0/integration_mappings/teams/12345" \
curl -L -X PUT "https://api.box.com/2.0/integration_mappings/teams/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H 'content-type: application/json' \
```
Expand All @@ -5138,7 +5136,7 @@ curl -X -L PUT "https://api.box.com/2.0/integration_mappings/teams/12345" \
<!-- sample delete_integration_mappings_teams_id -->

```bash
curl -X -L DELETE "https://api.box.com/2.0/integration_mappings/teams/342423" \
curl -L -X DELETE "https://api.box.com/2.0/integration_mappings/teams/342423" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d ''
```
Expand Down Expand Up @@ -5198,7 +5196,7 @@ curl -i -X DELETE "https://api.box.com/2.0/archives/12345" \
<!-- sample post_external_users_submit_delete_job -->

```bash
curl -X -L POST "https://api.box.com/2.0/external_users/external_users_submit_delete_job" \
curl -L -X POST "https://api.box.com/2.0/external_users/external_users_submit_delete_job" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"external_users":
Expand Down