Data Connectors

View as Markdown

List Connectors

GET/api/v1/brands/{brand_id}/connectors

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Create Connector

POST/api/v1/brands/{brand_id}/connectors

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/brands/{brand_id}/connectors" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Revoke Connector

POST/api/v1/connectors/{connector_id}/revoke

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/connectors/{connector_id}/revoke" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Poll Connector Jobs

GET/api/v1/connectors/jobs

Long-poll one job. A connector can only claim its own brand/id rows.

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl "https://app.opvs.ai/api/v1/connectors/jobs" \
  -H "Authorization: Bearer $OPVS_TOKEN"

Post Connector Result

POST/api/v1/connectors/jobs/{job_id}/result

Errors

CodeWhenWhat to do
422Validation Error—
Request
curl -X POST "https://app.opvs.ai/api/v1/connectors/jobs/{job_id}/result" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
Did this answer your question?