---
title: "Ask securely for an environment credential"
method: POST
path: "/v1/conversations/{id}/credential-requests"
tags: ["Secrets"]
---

# Ask securely for an environment credential

`POST /v1/conversations/{id}/credential-requests`

## Request

- Base URL: `https://api.shardflux.dev`
- URL: `https://api.shardflux.dev/v1/conversations/{id}/credential-requests`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string, required
  - `purpose` string, required
  - `suggested_scope` 'agents' | 'project' | 'conversation', required

## Response `201`

Default Response

- object
  - `id` string, uuid, required: UUIDv7, lowercase canonical form.
  - `conversation_id` string, required
  - `project_id` string, uuid, required: UUIDv7, lowercase canonical form.
  - `name` string, required
  - `purpose` string, required
  - `suggested_scope` 'agents' | 'project' | 'conversation', required
  - `state` 'pending' | 'provided' | 'denied', required
  - `created_at` string, date-time, required: RFC 3339 UTC timestamp with Z.

## Other responses

- `4XX`: Default Response
- `5XX`: Default Response

---

[API](https://skmtc.dev/shardflux/apis/shardflux-api.md) · [All operations](https://skmtc.dev/shardflux/apis/shardflux-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shardflux/apis/shardflux-api/revisions/ea685f7b39c4?raw)
