From 1121efe365e11c848440cc0e25ef8090e4e56a4c Mon Sep 17 00:00:00 2001
From: Pratik <10096516+pratikgajjar@users.noreply.github.com>
Date: Wed, 23 Sep 2026 10:29:15 -0700
Subject: [PATCH] docs(profiles): match the job create response in openapi

The 202 body documented usage_units and a results array. The API returns
entity_count_reserved, event_id and, for sample jobs, entity_ids; results
only appears on GET /v2/profiles/jobs/{id}/. The SDK types already use
entityCountReserved and entityIds, so the spec was the one out of step.

The docs sample example indexes entity_ids with .get(), matching the
notebook and the TS example's ?? [].
---
 docs/openapi.json                        | 16 ++++++++++------
 docs/platform/features/user-profiles.mdx |  2 +-
 2 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/docs/openapi.json b/docs/openapi.json
index 02c0eb562..e6fd1c65c 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -8450,8 +8450,13 @@
 										"entity_type": {
 											"type": "string"
 										},
-										"usage_units": {
-											"type": "integer"
+										"entity_count_reserved": {
+											"type": "integer",
+											"description": "Entities reserved against usage for this job."
+										},
+										"event_id": {
+											"type": "string",
+											"nullable": true
 										},
 										"replayed": {
 											"type": "boolean",
@@ -8461,13 +8466,12 @@
 											"type": "integer",
 											"description": "`sample` only."
 										},
-										"results": {
+										"entity_ids": {
 											"type": "array",
 											"items": {
-												"type": "object",
-												"additionalProperties": true
+												"type": "string"
 											},
-											"description": "`sample` only."
+											"description": "`sample` only: the entity ids picked. Read each with `GET /v2/entities/user/{entity_id}/profile/`."
 										}
 									}
 								}
diff --git a/docs/platform/features/user-profiles.mdx b/docs/platform/features/user-profiles.mdx
index 23aab18e8..1e99f59ea 100644
--- a/docs/platform/features/user-profiles.mdx
+++ b/docs/platform/features/user-profiles.mdx
@@ -200,7 +200,7 @@ while True:
 print(status["status"], status["succeeded"], "of", status["total"])
 
 # The create response lists the sampled entities; read each one's saved profile.
-for entity_id in job["entity_ids"]:
+for entity_id in job.get("entity_ids", []):
     print(client.get_profile(entity_id))
 ```