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

# Script Typings

## GET /api/{tenantId}/admin/configuration/script-typings

> Get script typings

```json
{"openapi":"3.1.1","info":{"title":"Neostore internal API","version":"v1"},"tags":[{"name":"ScriptTypings"}],"servers":[{"url":"https://app.neostore.cloud","description":"Production Server"},{"url":"https://app-qa.neostore.cloud","description":"Staging Server"}],"security":[{"admin-bearer":["tenant.core:read"]},{"apiKey":[]}],"components":{"securitySchemes":{"admin-bearer":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.neostore.cloud/authorize?audience=https://app.neostore.cloud/api/","scopes":{}}}},"apiKey":{"type":"apiKey","name":"X-API-KEY","in":"header"}},"schemas":{"ScriptTypings":{"type":"object","properties":{"declarations":{"type":"string","description":"The contents of a TypeScript declaration file describing `ScriptContext`. Types a\nscript that annotates its context parameter, down to the fields of every argument."},"endpoints":{"type":"array","items":{"description":"One endpoint a script may register an implementation for.","$ref":"#/components/schemas/ScriptEndpointSignature"},"description":"The same endpoints as data. A script cannot be made to carry that annotation, and\nTypeScript will not infer a parameter's type from the way it is used, so an editor also\nneeds the names on their own to complete `register(...)` without it."}},"additionalProperties":false,"description":"What an editor needs to help someone write an extensibility script."},"ScriptEndpointSignature":{"type":"object","properties":{"name":{"type":"string","description":"The name `register` is called with, placeholders included."},"description":{"type":["null","string"],"description":"What the endpoint is for, as its own documentation states it."},"methods":{"type":"array","items":{"description":"One method of an endpoint, named as a script has to spell it.","$ref":"#/components/schemas/ScriptMethodSignature"},"description":"The methods an implementation may carry."}},"additionalProperties":false,"description":"One endpoint a script may register an implementation for."},"ScriptMethodSignature":{"type":"object","properties":{"name":{"type":"string","description":"The property name an implementation is registered under."},"isOptional":{"type":"boolean","description":"Whether the endpoint declares the method optional. A script may leave an optional method\nout; leaving out a required one changes what the platform can do."},"description":{"type":["null","string"],"description":"What the method is for, as its own documentation states it."},"parameters":{"type":"array","items":{"type":"string"},"description":"The parameter names, in order, for scaffolding a handler."}},"additionalProperties":false,"description":"One method of an endpoint, named as a script has to spell it."},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}},"additionalProperties":{}},"HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}}},"paths":{"/api/{tenantId}/admin/configuration/script-typings":{"get":{"tags":["ScriptTypings"],"summary":"Get script typings","parameters":[{"name":"tenantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Typings returned.","content":{"text/plain":{"schema":{"description":"What an editor needs to help someone write an extensibility script.","$ref":"#/components/schemas/ScriptTypings"}},"application/json":{"schema":{"description":"What an editor needs to help someone write an extensibility script.","$ref":"#/components/schemas/ScriptTypings"}},"text/json":{"schema":{"description":"What an editor needs to help someone write an extensibility script.","$ref":"#/components/schemas/ScriptTypings"}}}},"401":{"description":"The caller is not authenticated.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"403":{"description":"The caller lacks the <c>tenant.core:read</c> scope.","content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}},"429":{"description":"Over 1200 requests per minute to this endpoint for the tenant (default limit); retry after <c>Retry-After</c>.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when the limiter knows it.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"$ref":"#/components/schemas/HttpValidationProblemDetails"}]}}}}}}}}}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.thewalletcrew.io/api-reference/advanced/script-typings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
