From 9f528c12d7f9215f3cbc082c64d5dd4b77f58a53 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 6 Jul 2023 16:46:05 -0400 Subject: [PATCH] update api documentation --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf4853cd..9d753af2 100644 --- a/README.md +++ b/README.md @@ -92,12 +92,18 @@ Finally, run a model! ## API Reference -### `POST /completion` +### `POST /api/pull` + +Download a model + +``` +curl -X POST http://localhost:11343/api/pull -d '{"model": "orca"}' +``` + +### `POST /api/generate` Complete a prompt ``` -curl --unix-socket ~/.ollama/ollama.sock http://localhost/api/generate \ - -X POST \ - -d '{"model": "/path/to/model", "prompt": "Once upon a time", "stream": true}' +curl -X POST http://localhost:11434/api/generate -d '{"model": "orca", "prompt": "hello!", "stream": true}' ```