> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.v2.rasen.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.v2.rasen.ai/_mcp/server. # Store a tool credential POST https://api.v2.rasen.ai/v1/secrets Content-Type: application/json Creates a secret and its immutable version 1 from write-only material. No readback. Does not bind or publish anything. Inline credentials on tool and MCP setup remain available and create the same resource. Reference: https://docs.v2.rasen.ai/api-reference/secrets/create ## Authentication - `Authorization` header (bearer token, required) — Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header. ## Request ### Headers - `Idempotency-Key` (string, required) — Stable key per logical intent, 1–255 printable characters. Persist it before sending. Retry the same key/body after an uncertain result for 24 hours. A changed body conflicts. Beyond retention, reconcile the resource before retrying; this is not permanent deduplication. Current authorization is rechecked on replay. Evaluation order: authenticate and check current authorization; look up intent; replay its stored receipt before checking the current revision; only a new intent evaluates If-Match and executes. Fingerprint includes method, path, body and original If-Match. A changed request returns idempotency_key_reused. The server stores only a keyed (HMAC) fingerprint, and no error or response ever returns a fingerprint or hash of a request. In-flight intent returns 409 idempotency_in_progress with Retry-After; retry the same intent after reconciliation. Receipts describe that attempt, not current resource state. A replay returns the original status code and body, with the response header Idempotent-Replayed: true. ### Body (application/json) This endpoint expects a SecretCreate. - `purpose` (enum, required) - Allowed values: `webhook_tool`, `mcp_server` - `material_kind` (enum, required) — A descriptive label that does not change how the value is sent. Rasen sends the stored value unchanged as the header value for a webhook secret header, or as "Bearer \" for an MCP server with auth=bearer, or as the header value for auth=secret\_header. For basic\_auth, store the complete header value, for example "Basic \", and use a secret header named Authorization. No kind and auth-mode pair is refused. - Allowed values: `api_key`, `bearer_token`, `basic_auth` - `value` (string, required) — Write-only credential material. Sealed inside the request transaction. Never returned, logged, included in diffs, errors, events or call evidence. - `name` (string, optional) — Optional handle. If omitted, Rasen generates one. - `resource_key` (string, optional) — Optional caller-chosen resource key: an opaque external identifier that matches your own record (for example a CRM ID, a configuration-file ID or a UUID) to this resource. Rasen still generates the canonical id; use id in paths and references. Case-sensitive, compared exactly, never normalized or parsed. 1-128 characters from A-Z a-z 0-9 . _ : ~ - and starting with a letter or digit; UUIDs and ULIDs are valid. Unique per resource type within one workspace; separate environment workspaces can reuse the same key. Set only at creation and immutable afterwards. A create with a key that already exists returns 409 resource_key_conflict with details.existing_id; it never updates or returns the existing resource. Not an Idempotency-Key: that header identifies one request intent for 24 hours, and a same-intent replay returns its original receipt before the resource-key check runs. Uniqueness includes archived resources. A key becomes free again only after its resource is permanently deleted or erased (a deleted secret or a deleted knowledge source); archive never frees it. ## Response ### 201 Store a tool credential. - `id` (string, required) — Opaque sec identifier. Do not parse its contents. - `resource_key` (string, required, nullable) — Optional caller-chosen resource key: an opaque external identifier that matches your own record (for example a CRM ID, a configuration-file ID or a UUID) to this resource. Rasen still generates the canonical id; use id in paths and references. Case-sensitive, compared exactly, never normalized or parsed. 1-128 characters from A-Z a-z 0-9 . _ : ~ - and starting with a letter or digit; UUIDs and ULIDs are valid. Unique per resource type within one workspace; separate environment workspaces can reuse the same key. Set only at creation and immutable afterwards. A create with a key that already exists returns 409 resource_key_conflict with details.existing_id; it never updates or returns the existing resource. Not an Idempotency-Key: that header identifies one request intent for 24 hours, and a same-intent replay returns its original receipt before the resource-key check runs. Uniqueness includes archived resources. A key becomes free again only after its resource is permanently deleted or erased (a deleted secret or a deleted knowledge source); archive never frees it. - `name` (string, required) — Workspace-unique handle among secrets that are not deleted. A label, not the resource key. Deletion frees the name and the resource_key. - `purpose` (string, required) — Consumer type the credential may be released to. A webhook_tool secret cannot be used by an MCP server, and the reverse. Open response vocabulary. Preserve unknown values; never assume they mean success. - `material_kind` (string, required) — A descriptive label that does not change how the value is sent. Rasen sends the stored value unchanged as the header value for a webhook secret header, or as "Bearer \" for an MCP server with auth=bearer, or as the header value for auth=secret\_header. For basic\_auth, store the complete header value, for example "Basic \", and use a secret header named Authorization. No kind and auth-mode pair is refused. Open response vocabulary. Preserve unknown values; never assume they mean success. - `state` (string, required) — revoked means every version is revoked. Open response vocabulary. Preserve unknown values; never assume they mean success. - `latest_version` (integer, required) — Highest version number. Not an implicit binding target: consumers pin exact versions. - `active_version_count` (integer, required) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `last_rotated_at` (datetime, required, nullable) - `usage` (SecretUsage, required) — Reference counts at response time. Use GET /secrets/\{secret\_id}/references for the exact consumers. ## Errors ### 400 Bad Request Error Invalid input or cursor. Correct the request. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 401 Unauthorized Error Invalid, expired or revoked API key. Creator departure or membership changes do not invalidate a workspace key. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 403 Forbidden Error Operation not allowed by current credential or workspace access. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 409 Conflict Error Conflict. Not retryable: read the current state, fix the request and send a new request. The one exception is idempotency_in_progress, which carries Retry-After: wait, then resend the identical request with the same Idempotency-Key. The operation lists its codes in x-error-codes; branch on error.code and, for conflict, error.details.reason. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 413 Content Too Large Error Body or upload exceeds its allowed limit. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 429 Too Many Requests Error Rate limited. Respect Retry-After and retry the same intent where permitted. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 500 Internal Server Error Internal error. The effect may have happened. Retry the same request with the same Idempotency-Key; read the resource before creating a new intent. For an operation that takes an Idempotency-Key, a client retry with the same key is safe: the server replays the stored outcome if the first attempt took effect; if the first attempt had no effect, the retry performs the operation once. Never retry with a new key. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ### 503 Service Unavailable Error Service unavailable. Respect Retry-After where present. For an operation that takes an Idempotency-Key, a client retry with the same key is safe: the server replays the stored outcome if the first attempt took effect; if the first attempt had no effect, the retry performs the operation once. Never retry with a new key. - `error` (ErrorResponseError, required) — Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. ## Types ### SecretUsage Reference counts at response time. Use GET /secrets/\{secret\_id}/references for the exact consumers. - `draft_binding_count` (integer, required) — Current draft tool headers and MCP server connections that reference this secret or version. - `published_version_count` (integer, required) — Retained published agent versions that pin this secret or version. - `live_version_count` (integer, required) — Of those, versions that are live for new calls now. ### ErrorResponseError Only code and message are required. Rasen sends details, request_id and retry on every error, but clients must parse an error that lacks them, so a typed error is never lost to a parsing failure. - `code` (string, required) — Stable code. Branch on code (and details.reason for conflict), never on message. Each code has one HTTP status; see components.x-error-catalog. - `message` (string, required) — Safe description; no provider payload or submitted secrets. - `details` (map from string to any, optional) — Safe code-specific details. The public fields for each code are listed in components.x-error-catalog. Details never contain a request fingerprint, a hash of a request, secret material or another tenant's data. forbidden may include required_capabilities (a list). - `request_id` (string, optional) — Same value as the X-Request-Id header. Quote it to support. - `retry` (string, optional) — Retry class of this code: no (fix the request or state first), yes (retry the same request and the same Idempotency-Key), retry_after (wait for Retry-After, then retry the same request). Open response vocabulary. Preserve unknown values; never assume they mean success. ## Examples **Request** ```json { "purpose": "webhook_tool", "material_kind": "bearer_token", "value": "", "name": "crm-webhook", "resource_key": "crm-webhook-token" } ``` **Response** ```json { "id": "sec_01j00000000000000000000000", "resource_key": "crm-webhook-token", "name": "crm-webhook", "purpose": "webhook_tool", "material_kind": "bearer_token", "state": "active", "latest_version": 1, "active_version_count": 1, "created_at": "2026-09-25T10:00:00Z", "updated_at": "2026-09-25T10:00:00Z", "last_rotated_at": null, "usage": { "draft_binding_count": 0, "published_version_count": 0, "live_version_count": 0 } } ``` **SDK Code** ```python secrets_create_example import requests url = "https://api.v2.rasen.ai/v1/secrets" payload = { "purpose": "webhook_tool", "material_kind": "bearer_token", "value": "", "name": "crm-webhook", "resource_key": "crm-webhook-token" } headers = { "Idempotency-Key": "intent-appointment-001", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript secrets_create_example const url = 'https://api.v2.rasen.ai/v1/secrets'; const options = { method: 'POST', headers: { 'Idempotency-Key': 'intent-appointment-001', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{"purpose":"webhook_tool","material_kind":"bearer_token","value":"","name":"crm-webhook","resource_key":"crm-webhook-token"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```ruby secrets_create_example require 'uri' require 'net/http' url = URI("https://api.v2.rasen.ai/v1/secrets") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Idempotency-Key"] = 'intent-appointment-001' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"purpose\": \"webhook_tool\",\n \"material_kind\": \"bearer_token\",\n \"value\": \"\",\n \"name\": \"crm-webhook\",\n \"resource_key\": \"crm-webhook-token\"\n}" response = http.request(request) puts response.read_body ``` ```java secrets_create_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.v2.rasen.ai/v1/secrets") .header("Idempotency-Key", "intent-appointment-001") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"purpose\": \"webhook_tool\",\n \"material_kind\": \"bearer_token\",\n \"value\": \"\",\n \"name\": \"crm-webhook\",\n \"resource_key\": \"crm-webhook-token\"\n}") .asString(); ``` ```php secrets_create_example request('POST', 'https://api.v2.rasen.ai/v1/secrets', [ 'body' => '{ "purpose": "webhook_tool", "material_kind": "bearer_token", "value": "", "name": "crm-webhook", "resource_key": "crm-webhook-token" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'Idempotency-Key' => 'intent-appointment-001', ], ]); echo $response->getBody(); ``` ```csharp secrets_create_example using RestSharp; var client = new RestClient("https://api.v2.rasen.ai/v1/secrets"); var request = new RestRequest(Method.POST); request.AddHeader("Idempotency-Key", "intent-appointment-001"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"purpose\": \"webhook_tool\",\n \"material_kind\": \"bearer_token\",\n \"value\": \"\",\n \"name\": \"crm-webhook\",\n \"resource_key\": \"crm-webhook-token\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift secrets_create_example import Foundation let headers = [ "Idempotency-Key": "intent-appointment-001", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "purpose": "webhook_tool", "material_kind": "bearer_token", "value": "", "name": "crm-webhook", "resource_key": "crm-webhook-token" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.v2.rasen.ai/v1/secrets")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```