latticesurgery-com/lattice-surgery-compiler

[Feature Request] api.latticesurgery.com API doc

Opened this issue · 0 comments

Issue Description

Add a page to the API that describes how to use the HTTP rest api (the one at api.latticesurgery.com or served by webapi/local_compiler_api_server.py)

Proposed Solution

Markdown files with curl and python examples, plus formal structure of the response.

Additional References

Example request:

JSON_POST_PARAMETERS = {
"circuit_source": "str", # alternative would be 'file'
"circuit": SAMPLE_CIRCUIT,
"apply_litinski_transform": True,
}

Response structure in Typescript:
https://github.com/latticesurgery-com/web-ui/blob/main/ls-ui-react-app/src/slices.ts