> For the complete documentation index, see [llms.txt](https://mydentify.gitbook.io/mydentify-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mydentify.gitbook.io/mydentify-docs/mydentify-public-api.md).

# Mydentify Public API

## GET /leaderboards.json

> Get the current product leaderboard, real activity, and completed results

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/leaderboards.json":{"get":{"summary":"Get the current product leaderboard, real activity, and completed results","responses":{"200":{"description":"Public leaderboard catalog","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}}}}
```

## GET /api/leaderboards/{slug}/json

> Get a permanent weekly leaderboard record and its public standings

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/leaderboards/{slug}/json":{"get":{"summary":"Get a permanent weekly leaderboard record and its public standings","parameters":[{"$ref":"#/components/parameters/LeaderboardSlug"}],"responses":{"200":{"description":"Leaderboard data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"Leaderboard not found"}}}}},"components":{"parameters":{"LeaderboardSlug":{"in":"path","name":"slug","required":true,"schema":{"type":"string"}}}}}
```

## GET /directories.json

> Get the complete public product-directory catalog

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/directories.json":{"get":{"summary":"Get the complete public product-directory catalog","responses":{"200":{"description":"Directory catalog with collection links and structured records","content":{"application/json":{"schema":{"type":"object","required":["type","humanUrl","jsonUrl","llmsTextUrl","totalRecords","records"],"properties":{"type":{"const":"directory-catalog"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"llmsTextUrl":{"type":"string","format":"uri"},"totalRecords":{"type":"integer"},"collections":{"type":"array","items":{"type":"object","additionalProperties":true}},"records":{"type":"array","items":{"$ref":"#/components/schemas/DirectoryRecord"}}}}}}}}}}},"components":{"schemas":{"DirectoryRecord":{"type":"object","required":["type","id","name","slug","domain","websiteUrl","canonicalUrl","jsonUrl","llmsTextUrl","description","category","pricing","link","directoryScore","scoreConfidence","verificationStatus","operatingStatus","updatedAt"],"properties":{"type":{"const":"directory-record"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"domain":{"type":"string"},"websiteUrl":{"type":"string","format":"uri"},"submissionUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"canonicalUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"llmsTextUrl":{"type":"string","format":"uri"},"description":{"type":"string"},"category":{"type":"string"},"pricing":{"type":"object","additionalProperties":true},"link":{"type":"object","additionalProperties":true},"directoryScore":{"type":"integer","minimum":0,"maximum":100},"scoreConfidence":{"type":"number","minimum":0,"maximum":1},"domainRating":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"verificationStatus":{"type":"string"},"operatingStatus":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## GET /product-categories.json

> Get Mydentify's portable product category taxonomy and directory mappings

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/product-categories.json":{"get":{"summary":"Get Mydentify's portable product category taxonomy and directory mappings","responses":{"200":{"description":"Product category catalog","content":{"application/json":{"schema":{"type":"object","required":["type","schemaVersion","categories"],"properties":{"type":{"const":"product-category-catalog"},"schemaVersion":{"type":"string"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"}}}}}}}}}}},"components":{"schemas":{"ProductCategory":{"type":"object","required":["slug","name","description","externalMappings","approvedProductCount"],"properties":{"slug":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"externalMappings":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"approvedProductCount":{"type":"integer","minimum":0}}}}}}
```

## GET /api/directories/{slug}/json

> Get structured data for a directory record, collection, or facet index

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/directories/{slug}/json":{"get":{"summary":"Get structured data for a directory record, collection, or facet index","parameters":[{"$ref":"#/components/parameters/DirectorySlug"}],"responses":{"200":{"description":"Page-specific directory payload","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"Directory page not found"}}}}},"components":{"parameters":{"DirectorySlug":{"in":"path","name":"slug","required":true,"schema":{"type":"string"}}}}}
```

## GET /directories/{slug}/llms.txt

> Get the concise Markdown representation of a directory record, collection, or facet index

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/directories/{slug}/llms.txt":{"get":{"summary":"Get the concise Markdown representation of a directory record, collection, or facet index","parameters":[{"$ref":"#/components/parameters/DirectorySlug"}],"responses":{"200":{"description":"LLM-readable directory page","content":{"text/markdown":{"schema":{"type":"string"}}}},"404":{"description":"Directory page not found"}}}}},"components":{"parameters":{"DirectorySlug":{"in":"path","name":"slug","required":true,"schema":{"type":"string"}}}}}
```

## POST /api/imports/dry-run

> Inspect identity and duplicates without creating a product

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/dry-run":{"post":{"summary":"Inspect identity and duplicates without creating a product","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}},"responses":{"200":{"description":"Inspection result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DryRunResult"}}}},"422":{"$ref":"#/components/responses/ImportError"},"503":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"schemas":{"DryRunResult":{"type":"object","required":["normalizedUrl","finalUrl","canonicalUrl","identity","discovered","nextAction"],"properties":{"normalizedUrl":{"type":"string","format":"uri"},"finalUrl":{"type":"string","format":"uri"},"canonicalUrl":{"type":"string","format":"uri"},"identity":{"type":"object","additionalProperties":true},"duplicate":{"anyOf":[{"$ref":"#/components/schemas/DuplicateResolution"},{"type":"null"}]},"discovered":{"type":"object","additionalProperties":true},"nextAction":{"type":"object","additionalProperties":true}}},"DuplicateResolution":{"type":"object","required":["classification","matchType","confidence","reason","claimed","product","proposedChanges","allowedActions"],"properties":{"classification":{"type":"string","enum":["exact_duplicate","probable_duplicate","renamed_product"]},"matchType":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1},"reason":{"type":"string"},"claimed":{"type":"boolean"},"product":{"$ref":"#/components/schemas/CanonicalProduct"},"proposedChanges":{"type":"array","items":{"type":"object","required":["field","proposed","sourceUrl"],"properties":{"field":{"type":"string"},"current":{},"proposed":{},"sourceUrl":{"type":"string","format":"uri"}}}},"allowedActions":{"type":"array","items":{"type":"object","required":["type","href"],"properties":{"type":{"type":"string","enum":["view_existing","claim_product","restore_access","review_proposed_updates"]},"href":{"type":"string"}}}}}},"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## POST /api/imports

> Create or reuse a durable product diagnostic or product import

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports":{"post":{"summary":"Create or reuse a durable product diagnostic or product import","parameters":[{"in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string","minLength":8,"maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportRequest"}}}},"responses":{"200":{"description":"Existing idempotent import"},"202":{"description":"Import queued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAccepted"}}}},"409":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"schemas":{"ImportRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"mode":{"type":"string","enum":["diagnostic","listing"],"default":"listing"},"requestedIntentSlug":{"type":"string"},"source":{"type":"string","enum":["human","agent"],"default":"human"},"submittedByAgent":{"type":"string","maxLength":120}}},"ImportAccepted":{"type":"object","required":["importId","status","statusUrl","eventsUrl","submittedAt","reused","nextAction"],"properties":{"importId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","running","needs_input","retry_scheduled","duplicate_detected","ready_for_confirmation","submitted_for_review","approved","rejected","failed","canceled"]},"statusUrl":{"type":"string","format":"uri"},"eventsUrl":{"type":"string","format":"uri"},"submittedAt":{"type":"string","format":"date-time"},"reused":{"type":"boolean"},"nextAction":{"type":"object","additionalProperties":true}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## GET /api/imports/{id}

> Get current import state, evidence candidates, warnings, duplicate resolution, and next action

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}":{"get":{"summary":"Get current import state, evidence candidates, warnings, duplicate resolution, and next action","parameters":[{"$ref":"#/components/parameters/ImportId"}],"responses":{"200":{"description":"Current import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportStatus"}}}},"404":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"ImportStatus":{"type":"object","required":["id","status","attemptCount","nextAction","stages","candidates","sourceFetches"],"properties":{"id":{"type":"string","format":"uuid"},"mode":{"type":"string","enum":["diagnostic","listing"]},"status":{"type":"string","enum":["queued","running","needs_input","retry_scheduled","duplicate_detected","ready_for_confirmation","submitted_for_review","approved","rejected","failed","canceled"]},"attemptCount":{"type":"integer","minimum":0},"nextAction":{"type":"object","additionalProperties":true},"remediation":{"anyOf":[{"$ref":"#/components/schemas/Remediation"},{"type":"null"}]},"duplicate":{"anyOf":[{"$ref":"#/components/schemas/DuplicateResolution"},{"type":"null"}]},"publication":{"anyOf":[{"$ref":"#/components/schemas/Publication"},{"type":"null"}]},"rejection":{"anyOf":[{"$ref":"#/components/schemas/Rejection"},{"type":"null"}]},"readinessReport":{"anyOf":[{"$ref":"#/components/schemas/ReadinessReport"},{"type":"null"}]},"stages":{"type":"array","items":{"type":"object","additionalProperties":true}},"candidates":{"type":"array","items":{"type":"object","additionalProperties":true}},"sourceFetches":{"type":"array","items":{"type":"object","additionalProperties":true}},"warnings":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"Remediation":{"type":"object","required":["summary","actions"],"properties":{"summary":{"type":"string"},"actions":{"type":"array","items":{"type":"object","required":["type","label","href"],"properties":{"type":{"type":"string","enum":["retry","retry_after","try_another_url","manual_review"]},"label":{"type":"string"},"href":{"type":"string"},"retryAfter":{"type":"string","format":"date-time"}}}}}},"DuplicateResolution":{"type":"object","required":["classification","matchType","confidence","reason","claimed","product","proposedChanges","allowedActions"],"properties":{"classification":{"type":"string","enum":["exact_duplicate","probable_duplicate","renamed_product"]},"matchType":{"type":"string"},"confidence":{"type":"number","minimum":0,"maximum":1},"reason":{"type":"string"},"claimed":{"type":"boolean"},"product":{"$ref":"#/components/schemas/CanonicalProduct"},"proposedChanges":{"type":"array","items":{"type":"object","required":["field","proposed","sourceUrl"],"properties":{"field":{"type":"string"},"current":{},"proposed":{},"sourceUrl":{"type":"string","format":"uri"}}}},"allowedActions":{"type":"array","items":{"type":"object","required":["type","href"],"properties":{"type":{"type":"string","enum":["view_existing","claim_product","restore_access","review_proposed_updates"]},"href":{"type":"string"}}}}}},"CanonicalProduct":{"type":"object","required":["id","name","slug","status","url","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}},"Publication":{"type":"object","required":["productId","humanUrl","jsonUrl","markdownUrl","supportedIntents"],"properties":{"productId":{"type":"string","format":"uuid"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"},"supportedIntents":{"type":"array","items":{"type":"object","required":["id","title","slug","humanUrl","jsonUrl","markdownUrl"],"properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"slug":{"type":"string"},"humanUrl":{"type":"string","format":"uri"},"jsonUrl":{"type":"string","format":"uri"},"markdownUrl":{"type":"string","format":"uri"}}}}}},"Rejection":{"type":"object","required":["category","message","correctionHint","publicNote"],"properties":{"category":{"type":"string","enum":["identity_unclear","insufficient_public_evidence","unsupported_or_private_source","duplicate_listing","inaccurate_claims","unsafe_or_prohibited"]},"message":{"type":"string"},"correctionHint":{"type":"string"},"publicNote":{"type":"string"}}},"ReadinessReport":{"type":"object","required":["rubricVersion","status","totalScore","confidence","summary","sourceCount","scannedAt","dimensions"],"properties":{"rubricVersion":{"type":"string"},"status":{"type":"string","enum":["complete","partial"]},"totalScore":{"type":"integer","minimum":0,"maximum":100},"confidence":{"type":"number","minimum":0,"maximum":1},"summary":{"type":"string"},"sourceCount":{"type":"integer","minimum":0},"scannedAt":{"type":"string","format":"date-time"},"dimensions":{"type":"array","minItems":5,"maxItems":5,"items":{"type":"object","required":["key","label","score","maxScore","summary","findings"],"properties":{"key":{"type":"string","enum":["product_understood","intent_coverage","evidence_strength","agent_accessibility","recommendation_readiness"]},"label":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":20},"maxScore":{"const":20},"summary":{"type":"string"},"findings":{"type":"array","items":{"type":"object","required":["code","label","status","score","maxScore","recommendation","evidence"],"properties":{"code":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["passed","partial","failed","unavailable","not_applicable"]},"score":{"type":"number"},"maxScore":{"type":"number"},"recommendation":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```

## GET /api/imports/{id}/events

> Stream durable import events

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}/events":{"get":{"summary":"Stream durable import events","parameters":[{"$ref":"#/components/parameters/ImportId"},{"in":"header","name":"Last-Event-ID","schema":{"type":"integer"}}],"responses":{"200":{"description":"SSE stream","content":{"text/event-stream":{}}}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}}}}
```

## POST /api/imports/{id}/retry

> Queue an allowed retry

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}/retry":{"post":{"summary":"Queue an allowed retry","parameters":[{"$ref":"#/components/parameters/ImportId"}],"responses":{"202":{"description":"Retry queued"},"409":{"$ref":"#/components/responses/ImportError"},"429":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}
```

## POST /api/imports/{id}/manual-review

> Preserve a failed import and send it to editorial review

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}/manual-review":{"post":{"summary":"Preserve a failed import and send it to editorial review","parameters":[{"$ref":"#/components/parameters/ImportId"}],"responses":{"200":{"description":"Manual review requested"},"404":{"$ref":"#/components/responses/ImportError"},"409":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}
```

## Confirm evidence-backed intents and choose the publication path

> Free products must publish the official badge from <https://mydentify.com/badges/listed-on-mydentify.svg> inside a direct crawlable link to <https://mydentify.com/>. A paid Player Pass publishes the product and enters the selected leaderboard after payment.

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}/goals":{"post":{"summary":"Confirm evidence-backed intents and choose the publication path","description":"Free products must publish the official badge from https://mydentify.com/badges/listed-on-mydentify.svg inside a direct crawlable link to https://mydentify.com/. A paid Player Pass publishes the product and enters the selected leaderboard after payment.","parameters":[{"$ref":"#/components/parameters/ImportId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["intentIds"],"properties":{"intentIds":{"type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"string","format":"uuid"}},"path":{"type":"string","enum":["free","player"],"default":"free"}}}}}},"responses":{"200":{"description":"Intent selection saved and publication path prepared"},"400":{"$ref":"#/components/responses/ImportError"},"409":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}
```

## POST /api/imports/{id}/verify-badge

> Recheck the required free-product badge and publish when verified

```json
{"openapi":"3.1.0","info":{"title":"Mydentify Public API","version":"1.4.0"},"servers":[{"url":"https://mydentify.com"}],"paths":{"/api/imports/{id}/verify-badge":{"post":{"summary":"Recheck the required free-product badge and publish when verified","parameters":[{"$ref":"#/components/parameters/ImportId"}],"responses":{"200":{"description":"Current badge verification and publication state"},"403":{"$ref":"#/components/responses/ImportError"},"404":{"$ref":"#/components/responses/ImportError"},"409":{"$ref":"#/components/responses/ImportError"}}}}},"components":{"parameters":{"ImportId":{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"ImportError":{"description":"Structured import error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retryAfter":{"type":"string","format":"date-time"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mydentify.gitbook.io/mydentify-docs/mydentify-public-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.