Skip to content
GenAIScript
Blog

Serve

Launch a local web server that is used to run the playground or Visual Studio Code.

Run from the workspace root:

Terminal window
npx genaiscript serve

port

The default port is 8003. You can specify the port by setting the --port flag.

Terminal window
npx genaiscript serve --port 8004

API key

The API key is used to authenticate the requests to the server. You can specify an API key by setting the --api-key flag or the GENAISCRIPT_API_KEY environment variable.

Terminal window
npx genaiscript serve --api-key my-api-key

or

.env
GENAISCRIPT_API_KEY=my-api-key

The API key can be set in the Authorization header of a request or in the URL query parameter api-key (http://localhost:8003/#api-key=my-api-key)

CORS

You can enable Cross Origin Shared Resource by setting the --cors flag or setting the GENAISCRIPT_CORS_ORIGIN environment variable.

Terminal window
npx genaiscript serve --cors contoso.com

Network

You can bind the server to 0.0.0.0 and make it accessible from the network by setting the --network flag.

Terminal window
npx genaiscript serve --network

We highly recommend setting the API key when running the server on the network.