Create a Use Case

Create a new use case in your workspace. Use cases help you organize vision events by deployment context (e.g., "Manufacturing Line 1", "Warehouse Inventory").

Required scope: vision-events:manage

Create a Use Case

post

Create a new use case in your workspace.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Body

application/json

namestring · min: 1 · max: 256Required

A name for the use case. Must be unique within the workspace.

Responses

201

Use case created successfully.

application/json

idstringOptional

namestringOptional

400

Validation error or duplicate name.

application/json

403

Insufficient permissions for this resource.

application/json

post

/vision-events/use-cases

HTTPcURLJavaScriptPython

POST /vision-events/use-cases HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "name": "text"
}

Request Body Parameters

• name (string, required): A name for the use case. Must be between 1 and 256 characters. The name is trimmed of leading/trailing whitespace and must be unique within the workspace.

Example Request

curl -X POST "https://api.roboflow.com/vision-events/use-cases" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Manufacturing Line 1"
  }'

Example Response

201

{
  "id": "a1b3c8e1",
  "name": "Manufacturing Line 1"
}

400

403

Notes

• New use cases are created with an active status by default.

• Use case names must be unique within a workspace. Attempting to create a use case with the same name as an existing one will return a 400 error.

• After creating a use case, you can reference its id as the useCaseId when creating vision events.