# /api/v1/services (management)

Source-derived management endpoint contract, authentication, request validation, responses, and errors.

Source: https://docs.minds.sh/docs/api/platform/reference/management--api-v1-services



This is the **management** service route. Its origin and authentication are described in [Platform API overview](/docs/api/platform) and [Authentication](/docs/api/platform/authentication). A path shared by another service is a different endpoint.

| Property                       | Contract                                                                       |
| ------------------------------ | ------------------------------------------------------------------------------ |
| Methods                        | POST, GET                                                                      |
| Path                           | `/api/v1/services`                                                             |
| Path parameters                | None                                                                           |
| Query parameters read in route | None read directly; schema validation below may define additional fields       |
| Headers read in route          | No additional direct header reads; authentication helpers may read credentials |

## Authentication and access [#authentication-and-access]

Management auth context: validated x-api-key or configured session authentication; trusted gateway integration may select its auth pipeline. Organization/tenant checks are separate.

## Request and response definitions [#request-and-response-definitions]

The following named definitions are imported or declared by this route. Optional markers, defaults, bounds, and enum values are shown exactly as implemented. A response type is a source contract, not an example populated with real account data.

### CreateServiceRequest [#createservicerequest]

```typescript
CreateServiceRequest = z.object({
  service_type: z.string(), // Service type name (e.g., "kv", "graph")
  name: z.string().min(1).max(100),
  slug: z
    .string()
    .regex(/^[a-z0-9-]+$/)
    .min(3)
    .max(63)
    .optional(), // Auto-generated if omitted
  plan: ServicePlanName.optional().default('free'),
  region: z.string().optional().default('us-east-1'),
  config: z.record(z.unknown()).optional(),
  tenant_id: z.string().optional(), // Link to existing tenant
})
```

Source: `minds-ui/apps/api-service/types/service.ts:131`.

### CreateServiceRequest [#createservicerequest-1]

```typescript
export type CreateServiceRequest = z.infer<typeof CreateServiceRequest>
```

Source: `minds-ui/apps/api-service/types/service.ts:146`.

### CreateServiceResponse [#createserviceresponse]

```typescript
CreateServiceResponse = z.object({
  service_id: z.string(),
  service_type: z.string(),
  name: z.string(),
  slug: z.string(),
  endpoint: z.string().url().optional(),
  status: z.literal('provisioning'),
  created_at: z.string().datetime(),
  estimated_ready_in: z.number().int(), // seconds
})
```

Source: `minds-ui/apps/api-service/types/service.ts:152`.

### CreateServiceResponse [#createserviceresponse-1]

```typescript
export type CreateServiceResponse = z.infer<typeof CreateServiceResponse>
```

Source: `minds-ui/apps/api-service/types/service.ts:163`.

### ListServicesQuery [#listservicesquery]

```typescript
ListServicesQuery = z.object({
  tenant_id: z.string().optional(),
  service_type: z.string().optional(),
  status: ServiceStatus.optional(),
  limit: z.coerce.number().int().min(1).max(100).default(20),
  offset: z.coerce.number().int().min(0).default(0),
})
```

Source: `minds-ui/apps/api-service/types/service.ts:181`.

### ListServicesQuery [#listservicesquery-1]

```typescript
export type ListServicesQuery = z.infer<typeof ListServicesQuery>
```

Source: `minds-ui/apps/api-service/types/service.ts:189`.

### ListServicesResponse [#listservicesresponse]

```typescript
ListServicesResponse = z.object({
  services: z.array(
    ServiceInstance.pick({
      id: true,
      service_type_id: true,
      tenant_id: true,
      name: true,
      slug: true,
      endpoint: true,
      plan: true,
      status: true,
      created_at: true,
    }),
  ),
  pagination: z.object({
    total: z.number().int(),
    limit: z.number().int(),
    offset: z.number().int(),
  }),
})
```

Source: `minds-ui/apps/api-service/types/service.ts:195`.

### ListServicesResponse [#listservicesresponse-1]

```typescript
export type ListServicesResponse = z.infer<typeof ListServicesResponse>
```

Source: `minds-ui/apps/api-service/types/service.ts:216`.

## Method behavior [#method-behavior]

The handler excerpt preserves field validation, response envelopes, cookie changes, and exception branches. Values returned by service helpers retain their named response type above; for passthrough routes, the upstream response is authoritative.

### POST [#post]

```typescript
export async function POST(request: NextRequest) {
  const requestId = generateRequestId()
  let rateLimitInfo: RateLimitMetadata | undefined

  try {
    const authContext = await resolveAuthContext(request)

    // Check idempotency
    const idempotencyKey = getIdempotencyKey(request)
    if (idempotencyKey) {
      const cached = await checkIdempotency(idempotencyKey)
      if (cached.found) {
        const evaluation = await enforceRateLimit({
          context: authContext,
        })
        rateLimitInfo = {
          ...evaluation.metadata,
          retryAfter: evaluation.retryAfter,
        }
        if (evaluation.blocked) {
          throw new RateLimitExceededError(evaluation.retryAfter ?? 60)
        }
        const response = apiSuccess(cached.response, cached.statusCode)
        return withRequestMetadata(response, requestId, rateLimitInfo)
      }
    }

    const body = await validateBody(request, CreateServiceRequest)

    const evaluation = await enforceRateLimit({
      context: authContext,
    })

    rateLimitInfo = {
      ...evaluation.metadata,
      retryAfter: evaluation.retryAfter,
    }

    if (evaluation.blocked) {
      throw new RateLimitExceededError(evaluation.retryAfter ?? 60)
    }

    const service = await createService(authContext, body)

    if (idempotencyKey) {
      await storeIdempotencyResult(
        idempotencyKey,
        service,
        202,
        '/api/v1/services',
        'POST',
      )
    }

    const response = apiAccepted<CreateServiceResponse>(service)
    return withRequestMetadata(response, requestId, rateLimitInfo)
  } catch (error) {
    if (error instanceof ApiError) {
      const response = apiError(error, requestId)
      return withRequestMetadata(response, requestId, rateLimitInfo)
    }
    console.error('Failed to create service:', error)
    const response = apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to create service'),
      requestId,
    )
    return withRequestMetadata(response, requestId, rateLimitInfo)
  }
}
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:34`.

### GET [#get]

```typescript
export async function GET(request: NextRequest) {
  const requestId = generateRequestId()
  let rateLimitInfo: RateLimitMetadata | undefined

  try {
    const authContext = await resolveAuthContext(request)
    const query = validateQuery(
      request.nextUrl.searchParams,
      ListServicesQuery,
    )

    const evaluation = await enforceRateLimit({
      context: authContext,
    })

    rateLimitInfo = {
      ...evaluation.metadata,
      retryAfter: evaluation.retryAfter,
    }

    if (evaluation.blocked) {
      throw new RateLimitExceededError(evaluation.retryAfter ?? 60)
    }

    const result = await listServices(authContext, query)

    const response = apiSuccess<ListServicesResponse>(result)
    return withRequestMetadata(response, requestId, rateLimitInfo)
  } catch (error) {
    if (error instanceof ApiError) {
      const response = apiError(error, requestId)
      return withRequestMetadata(response, requestId, rateLimitInfo)
    }
    console.error('Failed to list services:', error)
    const response = apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to list services'),
      requestId,
    )
    return withRequestMetadata(response, requestId, rateLimitInfo)
  }
}
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:108`.

## Response and error branches [#response-and-error-branches]

Literal HTTP statuses in the route: 500. Shared management error classes are defined in [Errors and responses](/docs/api/platform/errors).

```typescript
new RateLimitExceededError(evaluation.retryAfter ?? 60)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:54`.

```typescript
apiSuccess(cached.response, cached.statusCode)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:56`.

```typescript
new RateLimitExceededError(evaluation.retryAfter ?? 60)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:73`.

```typescript
apiAccepted<CreateServiceResponse>(service)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:88`.

```typescript
apiError(error, requestId)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:92`.

```typescript
apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to create service'),
      requestId,
    )
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:96`.

```typescript
new ApiError(500, 'INTERNAL_ERROR', 'Failed to create service')
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:97`.

```typescript
new RateLimitExceededError(evaluation.retryAfter ?? 60)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:129`.

```typescript
apiSuccess<ListServicesResponse>(result)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:134`.

```typescript
apiError(error, requestId)
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:138`.

```typescript
apiError(
      new ApiError(500, 'INTERNAL_ERROR', 'Failed to list services'),
      requestId,
    )
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:142`.

```typescript
new ApiError(500, 'INTERNAL_ERROR', 'Failed to list services')
```

Source: `minds-ui/apps/api-service/app/api/v1/services/route.ts:143`.

## Service dependencies [#service-dependencies]

* `minds-ui/apps/api-service/lib/api-response.ts`
* `minds-ui/apps/api-service/lib/validation.ts`
* `minds-ui/apps/api-service/lib/idempotency.ts`
* `minds-ui/apps/api-service/types/service.ts`
* `minds-ui/apps/api-service/types/errors.ts`
* `minds-ui/apps/api-service/lib/services/auth-context.ts`
* `minds-ui/apps/api-service/lib/services/service-manager.ts`
* `minds-ui/apps/api-service/lib/services/rate-limit.ts`

## Evidence [#evidence]

Generated from the local source snapshot on 2026-09-12. This page documents implemented code and does not certify a deployed service, permissions configuration, or successful provider operation.

Source file: `minds-ui/apps/api-service/app/api/v1/services/route.ts`. SHA-256: `e77c89bcfb6ce5575c448a4c2048bb5f018acd28d8c6e3fa30f92d4d10339f63`.