Skip to content

API reference

Public Tenant API. Every endpoint, every error.

Base URL https://api.link.l1fe.ai/v1. Authenticate with x-link-api-key or a Keystone bearer. Every error is RFC 7807 problem-details with a stable machine code. Idempotency-Key honored on every mutating endpoint.

Endpoint reference

Generated from the OpenAPI 3.1 source.

meta

GET/healthLiveness probe

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/health' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/statusComponent-level health

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/status' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/incidents/publicRedacted public incident history (last 30 days)

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/incidents/public' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/meta/openapiLive OpenAPI 3.1 document (source of truth)

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/meta/openapi' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

jobs

GET/jobsList jobs for the authenticated tenant

Responses

  • 200
  • 400
curl -X GET 'https://api.link.l1fe.ai/v1/jobs' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
POST/jobs/quoteQuote a job

Responses

  • 200
  • 422
  • 429
curl -X POST 'https://api.link.l1fe.ai/v1/jobs/quote' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
POST/jobs/bookBook a quoted job

Responses

  • 201
  • 402
  • 409
  • 410
curl -X POST 'https://api.link.l1fe.ai/v1/jobs/book' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
GET/jobs/{id}Read a job

Responses

  • 200
  • 404
curl -X GET 'https://api.link.l1fe.ai/v1/jobs/{id}' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
POST/jobs/{id}/cancelCancel a job

Responses

  • 200
  • 409
curl -X POST 'https://api.link.l1fe.ai/v1/jobs/{id}/cancel' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
GET/jobs/{id}/eventsStream public job tracking events

Responses

  • 200
  • 404
curl -X GET 'https://api.link.l1fe.ai/v1/jobs/{id}/events' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
POST/jobs/{id}/eventsIngest a signed driver job event

Responses

  • 200
  • 400
  • 401
  • 409
curl -X POST 'https://api.link.l1fe.ai/v1/jobs/{id}/events' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'

cities

GET/citiesList live cities

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/cities' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/cities/{cityId}/capabilitiesCity capability matrix (cold-truck, frozen, bonded-medical, ...)

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/cities/{cityId}/capabilities' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

webhooks

POST/webhooksRegister a webhook

Responses

  • 201
curl -X POST 'https://api.link.l1fe.ai/v1/webhooks' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'

maps

GET/maps/overlay/activeActive public map overlay

Responses

  • 200
curl -X GET 'https://api.link.l1fe.ai/v1/maps/overlay/active' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

driver

POST/driver/onlineMark the authenticated driver online

Responses

  • 200
  • 401
  • 422
  • 503
curl -X POST 'https://api.link.l1fe.ai/v1/driver/online' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
POST/driver/offlineMark the authenticated driver offline

Responses

  • 200
  • 401
  • 503
curl -X POST 'https://api.link.l1fe.ai/v1/driver/offline' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
POST/driver/locationUpdate the authenticated driver's current location

Responses

  • 200
  • 400
  • 401
  • 409
  • 503
curl -X POST 'https://api.link.l1fe.ai/v1/driver/location' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
GET/driver/active-jobRead the authenticated driver's currently assigned job

Responses

  • 200
  • 401
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/driver/active-job' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/driver/profileRead the authenticated driver's app profile

Responses

  • 200
  • 401
  • 404
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/driver/profile' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/driver/capabilityRead the authenticated driver's verified capability profile

Responses

  • 200
  • 401
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/driver/capability' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
GET/driver/earnings/todayRead today's earnings for the authenticated driver

Responses

  • 200
  • 400
  • 401
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/driver/earnings/today' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

rider

GET/rider/profileRead the authenticated rider's app profile

Responses

  • 200
  • 401
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/rider/profile' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

concierge

POST/concierge/messagesSend a rider message to live Concierge

Responses

  • 200
  • 400
  • 401
  • 503
curl -X POST 'https://api.link.l1fe.ai/v1/concierge/messages' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'

settlement

GET/settlement/tenants/{tenant}/statementsList posted settlement statement rows for a tenant

Responses

  • 200
  • 401
  • 403
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/settlement/tenants/{tenant}/statements' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'

tenants

GET/tenants/{tenant}/keysList API keys for the authenticated tenant

Responses

  • 200
  • 401
  • 403
  • 503
curl -X GET 'https://api.link.l1fe.ai/v1/tenants/{tenant}/keys' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json'
POST/tenants/{tenant}/keysMint an API key for the authenticated tenant

Responses

  • 201
  • 400
  • 401
  • 403
  • 503
curl -X POST 'https://api.link.l1fe.ai/v1/tenants/{tenant}/keys' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'
DELETE/tenants/{tenant}/keys/{keyId}Revoke an API key owned by the authenticated tenant

Responses

  • 200
  • 401
  • 403
  • 404
  • 503
curl -X DELETE 'https://api.link.l1fe.ai/v1/tenants/{tenant}/keys/{keyId}' \
  -H 'x-link-api-key: $LINK_API_KEY' \
  -H 'content-type: application/json' \
  -d '{}'